{ "openapi": "3.0.3", "info": { "title": "API Reference", "version": "v0", "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" } }, "paths": { "/api/0/organizations/": { "get": { "operationId": "List Your Organizations", "description": "Return a list of organizations available to the authenticated session in a region.\nThis is particularly useful for requests with a user bound context. For API key-based requests this will only return the organization that belongs to the key.", "parameters": [ { "in": "query", "name": "owner", "schema": { "type": "boolean" }, "description": "Specify `true` to restrict results to organizations in which you are an owner." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Filters results by using [query syntax](/product/sentry-basics/search/).\n\nValid query fields include:\n- `id`: The organization ID\n- `slug`: The organization slug\n- `status`: The organization's current status (one of `active`, `pending_deletion`, or `deletion_in_progress`)\n- `email` or `member_id`: Filter your organizations by the emails or [organization member IDs](/api/organizations/list-an-organizations-members/) of specific members included\n- `query`: Filter your organizations by name, slug, and members that contain this substring\n\nExample: `query=(slug:foo AND status:active) OR (email:[thing-one@example.com,thing-two@example.com] AND query:bar)`\n" }, { "in": "query", "name": "sortBy", "schema": { "type": "string" }, "description": "The field to sort results by, in descending order. If not specified the results are sorted by the date they were created.\n\nValid fields include:\n- `members`: By number of members\n- `events`: By number of events in the past 24 hours\n" } ], "tags": [ "Users" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] } }, "examples": { "ListYourOrganizations": { "value": [ { "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "dateCreated": "2018-11-06T21:19:55.101Z", "features": [ "session-replay-video", "onboarding", "advanced-search", "monitor-seat-billing", "issue-platform" ], "hasAuthProvider": false, "id": "2", "isEarlyAdopter": false, "allowMemberInvite": true, "allowMemberProjectCreation": true, "allowSuperuserAccess": false, "links": { "organizationUrl": "https://the-interstellar-jurisdiction.sentry.io", "regionUrl": "https://us.sentry.io" }, "name": "The Interstellar Jurisdiction", "require2FA": false, "slug": "the-interstellar-jurisdiction", "status": { "id": "active", "name": "active" } } ], "summary": "List your organizations" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/": { "get": { "operationId": "Retrieve an Organization", "description": "Return details on an individual organization, including various details\nsuch as membership access and teams.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "detailed", "schema": { "type": "string" }, "description": "\nSpecify `\"0\"` to return organization details that do not include projects or teams.\n" } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "examples": { "RetrieveAnOrganization": { "value": { "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "dateCreated": "2018-11-06T21:19:55.101Z", "hasAuthProvider": false, "id": "2", "isEarlyAdopter": false, "allowMemberInvite": true, "allowMemberProjectCreation": true, "allowSuperuserAccess": false, "links": { "organizationUrl": "https://the-interstellar-jurisdiction.sentry.io", "regionUrl": "https://us.sentry.io" }, "name": "The Interstellar Jurisdiction", "require2FA": false, "slug": "the-interstellar-jurisdiction", "status": { "id": "active", "name": "active" } }, "summary": "Retrieve an organization" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update an Organization", "description": "Update various attributes and configurable settings for the given organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Organizations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "The new slug for the organization, which needs to be unique.", "maxLength": 50 }, "name": { "type": "string", "description": "The new name for the organization.", "maxLength": 64 }, "isEarlyAdopter": { "type": "boolean", "description": "Specify `true` to opt-in to new features before they're released to the public." }, "hideAiFeatures": { "type": "boolean", "description": "Specify `true` to hide AI features from the organization." }, "codecovAccess": { "type": "boolean", "description": "Specify `true` to enable Code Coverage Insights. This feature is only available for organizations on the Team plan and above. Learn more about Codecov [here](/product/codecov/)." }, "defaultRole": { "enum": [ "member", "admin", "manager", "owner" ], "type": "string", "description": "The default role new members will receive.\n\n* `member` - Member\n* `admin` - Admin\n* `manager` - Manager\n* `owner` - Owner" }, "openMembership": { "type": "boolean", "description": "Specify `true` to allow organization members to freely join any team." }, "eventsMemberAdmin": { "type": "boolean", "description": "Specify `true` to allow members to delete events (including the delete & discard action) by granting them the `event:admin` scope." }, "alertsMemberWrite": { "type": "boolean", "description": "Specify `true` to allow members to create, edit, and delete alert rules by granting them the `alerts:write` scope." }, "attachmentsRole": { "enum": [ "member", "admin", "manager", "owner" ], "type": "string", "description": "The role required to download event attachments, such as native crash reports or log files.\n\n* `member` - Member\n* `admin` - Admin\n* `manager` - Manager\n* `owner` - Owner" }, "debugFilesRole": { "enum": [ "member", "admin", "manager", "owner" ], "type": "string", "description": "The role required to download debug information files, ProGuard mappings and source maps.\n\n* `member` - Member\n* `admin` - Admin\n* `manager` - Manager\n* `owner` - Owner" }, "hasGranularReplayPermissions": { "type": "boolean", "description": "Specify `true` to enable granular replay permissions, allowing per-member access control for replay data." }, "replayAccessMembers": { "type": "array", "items": { "type": "integer" }, "nullable": true, "description": "A list of user IDs who have permission to access replay data. Requires the hasGranularReplayPermissions flag to be true to be enforced." }, "avatarType": { "enum": [ "letter_avatar", "upload" ], "type": "string", "description": "The type of display picture for the organization.\n\n* `letter_avatar` - Use initials\n* `upload` - Upload an image" }, "avatar": { "type": "string", "description": "The image to upload as the organization avatar, in base64. Required if `avatarType` is `upload`." }, "require2FA": { "type": "boolean", "description": "Specify `true` to require and enforce two-factor authentication for all members." }, "allowSharedIssues": { "type": "boolean", "description": "Specify `true` to allow sharing of limited details on issues to anonymous users." }, "enhancedPrivacy": { "type": "boolean", "description": "Specify `true` to enable enhanced privacy controls to limit personally identifiable information (PII) as well as source code in things like notifications." }, "scrapeJavaScript": { "type": "boolean", "description": "Specify `true` to allow Sentry to scrape missing JavaScript source context when possible." }, "storeCrashReports": { "enum": [ 0, 1, 5, 10, 20, 50, 100, -1 ], "type": "integer", "description": "How many native crash reports (such as Minidumps for improved processing and download in issue details) to store per issue.\n\n* `0` - Disabled\n* `1` - 1 per issue\n* `5` - 5 per issue\n* `10` - 10 per issue\n* `20` - 20 per issue\n* `50` - 50 per issue\n* `100` - 100 per issue\n* `-1` - Unlimited" }, "allowJoinRequests": { "type": "boolean", "description": "Specify `true` to allow users to request to join your organization." }, "dataScrubber": { "type": "boolean", "description": "Specify `true` to require server-side data scrubbing for all projects." }, "dataScrubberDefaults": { "type": "boolean", "description": "Specify `true` to apply the default scrubbers to prevent things like passwords and credit cards from being stored for all projects." }, "sensitiveFields": { "type": "array", "items": { "type": "string" }, "description": "A list of additional global field names to match against when scrubbing data for all projects." }, "safeFields": { "type": "array", "items": { "type": "string" }, "description": "A list of global field names which data scrubbers should ignore." }, "scrubIPAddresses": { "type": "boolean", "description": "Specify `true` to prevent IP addresses from being stored for new events on all projects." }, "relayPiiConfig": { "type": "string", "description": "Advanced data scrubbing rules that can be configured for each project as a JSON string. The new rules will only apply to new incoming events. For more details on advanced data scrubbing, see our [full documentation](/security-legal-pii/scrubbing/advanced-datascrubbing/).\n\n> Warning: Calling this endpoint with this field fully overwrites the advanced data scrubbing rules.\n\nBelow is an example of a payload for a set of advanced data scrubbing rules for masking credit card numbers from the log message (equivalent to `[Mask] [Credit card numbers] from [$message]` in the Sentry app) and removing a specific key called `foo` (equivalent to `[Remove] [Anything] from [extra.foo]` in the Sentry app):\n```json\n{\n relayPiiConfig: \"{\\\"rules\":{\\\"0\\\":{\\\"type\\\":\\\"creditcard\\\",\\\"redaction\\\":{\\\"method\\\":\\\"mask\\\"}},\\\"1\\\":{\\\"type\\\":\\\"anything\\\",\\\"redaction\\\":{\\\"method\\\":\\\"remove\\\"}}},\\\"applications\\\":{\\\"$message\\\":[\\\"0\\\"],\\\"extra.foo\\\":[\\\"1\\\"]}}\"\n}\n```\n " }, "trustedRelays": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "A list of local Relays (the name, public key, and description as a JSON) registered for the organization. This feature is only available for organizations on the Business and Enterprise plans. Read more about Relay [here](/product/relay/).\n\n Below is an example of a list containing a single local Relay registered for the organization:\n ```json\n {\n trustedRelays: [\n {\n name: \"my-relay\",\n publicKey: \"eiwr9fdruw4erfh892qy4493reyf89ur34wefd90h\",\n description: \"Configuration for my-relay.\"\n }\n ]\n }\n ```\n " }, "issueAlertsThreadFlag": { "type": "boolean", "description": "Specify `true` to allow the Sentry Slack integration to post replies in threads for an Issue Alert notification. Requires a Slack integration." }, "metricAlertsThreadFlag": { "type": "boolean", "description": "Specify `true` to allow the Sentry Slack integration to post replies in threads for a Metric Alert notification. Requires a Slack integration." }, "cancelDeletion": { "type": "boolean", "description": "Specify `true` to restore an organization that is pending deletion." } } } } } }, "security": [ { "auth_token": [ "org:admin", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" }, "role": {}, "orgRole": { "type": "string" }, "targetSampleRate": { "type": "number", "format": "double" }, "samplingMode": { "type": "string" }, "planSampleRate": { "type": "number", "format": "double" }, "desiredSampleRate": { "type": "number", "format": "double" }, "experiments": { "type": "object", "additionalProperties": { "type": "string" } }, "isDefault": { "type": "boolean" }, "defaultRole": { "type": "string" }, "orgRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "is_global": { "type": "boolean" }, "isGlobal": { "type": "boolean" }, "minimumTeamRole": { "type": "string" } }, "required": [ "allowed", "desc", "id", "isAllowed", "isGlobal", "isRetired", "isTeamRolesAllowed", "is_global", "minimumTeamRole", "name", "scopes" ] } }, "teamRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "isMinimumRoleFor": { "type": "string", "nullable": true } }, "required": [ "allowed", "desc", "id", "isAllowed", "isMinimumRoleFor", "isRetired", "isTeamRolesAllowed", "name", "scopes" ] } }, "openMembership": { "type": "boolean" }, "allowSharedIssues": { "type": "boolean" }, "enhancedPrivacy": { "type": "boolean" }, "dataScrubber": { "type": "boolean" }, "dataScrubberDefaults": { "type": "boolean" }, "sensitiveFields": { "type": "array", "items": { "type": "string" } }, "safeFields": { "type": "array", "items": { "type": "string" } }, "storeCrashReports": { "type": "integer" }, "attachmentsRole": { "type": "string" }, "debugFilesRole": { "type": "string" }, "eventsMemberAdmin": { "type": "boolean" }, "alertsMemberWrite": { "type": "boolean" }, "scrubIPAddresses": { "type": "boolean" }, "scrapeJavaScript": { "type": "boolean" }, "allowJoinRequests": { "type": "boolean" }, "relayPiiConfig": { "type": "string", "nullable": true }, "trustedRelays": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "publicKey": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "lastModified": { "type": "string", "format": "date-time" } } } }, "pendingAccessRequests": { "type": "integer" }, "codecovAccess": { "type": "boolean" }, "hideAiFeatures": { "type": "boolean" }, "aggregatedDataConsent": { "type": "boolean" }, "isDynamicallySampled": { "type": "boolean" }, "issueAlertsThreadFlag": { "type": "boolean" }, "metricAlertsThreadFlag": { "type": "boolean" }, "requiresSso": { "type": "boolean" }, "defaultAutofixAutomationTuning": { "type": "string" }, "defaultSeerScannerAutomation": { "type": "boolean" }, "enableSeerCoding": { "type": "boolean" }, "defaultCodingAgent": { "type": "string" }, "defaultCodingAgentIntegrationId": { "type": "string", "nullable": true }, "defaultAutomatedRunStoppingPoint": { "type": "string" }, "autoEnableCodeReview": { "type": "boolean" }, "autoOpenPrs": { "type": "boolean" }, "defaultCodeReviewTriggers": { "type": "array", "items": { "type": "string" } }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "latestDeploys": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "nullable": true }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "hasUserReports": { "type": "boolean" }, "environments": { "type": "array", "items": { "type": "string" } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true } }, "required": [ "access", "dateCreated", "environments", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "hasUserReports", "id", "isBookmarked", "isMember", "latestRelease", "name", "platform", "platforms", "slug", "team", "teams" ] } } }, "required": [ "aggregatedDataConsent", "alertsMemberWrite", "allowJoinRequests", "allowMemberInvite", "allowMemberProjectCreation", "allowSharedIssues", "allowSuperuserAccess", "attachmentsRole", "autoEnableCodeReview", "autoOpenPrs", "avatar", "codecovAccess", "dataScrubber", "dataScrubberDefaults", "dateCreated", "debugFilesRole", "defaultAutofixAutomationTuning", "defaultAutomatedRunStoppingPoint", "defaultCodeReviewTriggers", "defaultCodingAgent", "defaultCodingAgentIntegrationId", "defaultRole", "defaultSeerScannerAutomation", "enableSeerCoding", "enhancedPrivacy", "eventsMemberAdmin", "experiments", "hasAuthProvider", "hideAiFeatures", "id", "isDefault", "isDynamicallySampled", "isEarlyAdopter", "issueAlertsThreadFlag", "links", "metricAlertsThreadFlag", "name", "openMembership", "orgRoleList", "pendingAccessRequests", "projects", "relayPiiConfig", "require2FA", "requiresSso", "safeFields", "scrapeJavaScript", "scrubIPAddresses", "sensitiveFields", "slug", "status", "storeCrashReports", "teamRoleList", "teams", "trustedRelays" ] }, "examples": { "UpdateAnOrganization": { "value": { "id": "2", "slug": "the-interstellar-jurisdiction", "status": { "id": "active", "name": "active" }, "name": "The Interstellar Jurisdiction", "dateCreated": "2018-11-06T21:19:55.101Z", "isEarlyAdopter": false, "allowMemberInvite": true, "allowMemberProjectCreation": true, "allowSuperuserAccess": false, "require2FA": false, "requiresSso": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": null }, "links": { "organizationUrl": "https://the-interstellar-jurisdiction.sentry.io", "regionUrl": "https://us.sentry.io" }, "hasAuthProvider": false, "access": [ "org:integrations", "member:admin", "alerts:write", "team:write", "team:admin", "project:write", "org:read", "member:write", "project:read", "member:read", "event:admin", "event:write", "org:write", "org:admin", "project:releases", "org:billing", "project:admin", "team:read", "event:read", "alerts:read" ], "onboardingTasks": [ { "task": "create_project", "status": "complete", "completionSeen": null, "dateCompleted": "2019-06-17T18:56:25.856360Z", "data": {} } ], "experiments": {}, "isDefault": false, "defaultRole": "member", "orgRoleList": [ { "id": "billing", "name": "Billing", "desc": "Can manage subscription and billing details.", "scopes": [ "org:billing" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": false, "minimumTeamRole": "contributor" }, { "id": "member", "name": "Member", "desc": "Members can view and act on events, as well as view most other data within the organization.", "scopes": [ "team:read", "project:releases", "org:read", "event:read", "alerts:write", "member:read", "alerts:read", "event:admin", "project:read", "event:write" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": true, "minimumTeamRole": "contributor" }, { "id": "admin", "name": "Admin", "desc": "Admin privileges on any teams of which they're a member. They can create new teams and projects, as well as remove teams and projects on which they already hold membership (or all teams, if open membership is enabled). Additionally, they can manage memberships of teams that they are members of. They cannot invite members to the organization.", "scopes": [ "team:admin", "org:integrations", "project:admin", "team:read", "project:releases", "org:read", "team:write", "event:read", "alerts:write", "member:read", "alerts:read", "event:admin", "project:read", "event:write", "project:write" ], "allowed": true, "isAllowed": true, "isRetired": true, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" }, { "id": "manager", "name": "Manager", "desc": "Gains admin access on all teams as well as the ability to add and remove members.", "scopes": [ "team:admin", "org:integrations", "project:releases", "team:write", "member:read", "org:write", "project:write", "project:admin", "team:read", "org:read", "event:read", "member:write", "alerts:write", "alerts:read", "event:admin", "project:read", "event:write", "member:admin" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": true, "isGlobal": true, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" }, { "id": "owner", "name": "Owner", "desc": "Unrestricted access to the organization, its data, and its settings. Can add, modify, and delete projects and members, as well as make billing and plan changes.", "scopes": [ "team:admin", "org:integrations", "project:releases", "org:admin", "team:write", "member:read", "org:write", "project:write", "project:admin", "team:read", "org:read", "event:read", "member:write", "alerts:write", "org:billing", "alerts:read", "event:admin", "project:read", "event:write", "member:admin" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": true, "isGlobal": true, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" } ], "teamRoleList": [ { "id": "contributor", "name": "Contributor", "desc": "Contributors can view and act on events, as well as view most other data within the team's projects.", "scopes": [ "project:read", "project:releases", "member:read", "team:read", "event:read", "alerts:read", "event:write", "org:read" ], "allowed": false, "isAllowed": false, "isRetired": false, "isTeamRolesAllowed": true, "isMinimumRoleFor": null }, { "id": "admin", "name": "Team Admin", "desc": "Admin privileges on the team. They can create and remove projects, and can manage the team's memberships.", "scopes": [ "project:read", "project:releases", "member:read", "event:admin", "team:write", "project:admin", "team:read", "org:integrations", "alerts:write", "team:admin", "project:write", "event:read", "alerts:read", "event:write", "org:read" ], "allowed": false, "isAllowed": false, "isRetired": false, "isTeamRolesAllowed": true, "isMinimumRoleFor": "admin" } ], "openMembership": true, "allowSharedIssues": true, "enhancedPrivacy": false, "dataScrubber": false, "dataScrubberDefaults": false, "sensitiveFields": [], "safeFields": [], "storeCrashReports": 0, "attachmentsRole": "member", "debugFilesRole": "admin", "eventsMemberAdmin": true, "alertsMemberWrite": true, "scrubIPAddresses": false, "scrapeJavaScript": true, "allowJoinRequests": true, "relayPiiConfig": null, "codecovAccess": false, "hideAiFeatures": false, "aggregatedDataConsent": false, "defaultAutofixAutomationTuning": "off", "autoEnableCodeReview": true, "defaultCodeReviewTriggers": [ "on_ready_for_review", "on_new_commit" ], "defaultSeerScannerAutomation": true, "enableSeerCoding": true, "autoOpenPrs": false, "defaultCodingAgent": "seer", "defaultCodingAgentIntegrationId": null, "defaultAutomatedRunStoppingPoint": "code_changes", "issueAlertsThreadFlag": true, "metricAlertsThreadFlag": true, "trustedRelays": [], "role": "owner", "orgRole": "owner", "pendingAccessRequests": 0, "isDynamicallySampled": false, "teams": [ { "id": "1", "slug": "my-team", "name": "my-team", "dateCreated": "2019-06-17T18:56:19.729172Z", "isMember": true, "teamRole": "admin", "flags": { "idp:provisioned": false }, "access": [ "project:read", "project:releases", "member:read", "event:admin", "team:write", "project:admin", "team:read", "org:integrations", "alerts:write", "team:admin", "project:write", "event:read", "alerts:read", "event:write", "org:read" ], "hasAccess": true, "isPending": false, "memberCount": 1, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null } } ], "projects": [ { "team": { "id": "1", "slug": "my-team", "name": "my-team" }, "teams": [ { "id": "1", "slug": "my-team", "name": "my-team" } ], "id": "1", "name": "node", "slug": "node", "isBookmarked": false, "isMember": true, "access": [ "project:read", "project:releases", "member:read", "event:admin", "team:write", "project:admin", "team:read", "org:integrations", "alerts:write", "team:admin", "project:write", "event:read", "alerts:read", "event:write", "org:read" ], "hasAccess": true, "dateCreated": "2019-06-17T18:56:25.777769Z", "environments": [], "features": [ "releases" ], "firstEvent": null, "firstTransactionEvent": false, "hasSessions": false, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasFeedbacks": false, "hasNewFeedbacks": false, "hasMonitors": false, "hasMinifiedStackTrace": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "platform": "node", "platforms": [], "latestRelease": null, "hasUserReports": false, "latestDeploys": null } ] }, "summary": "Update an organization" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "413": { "description": "Image too large." } } } }, "/api/0/organizations/{organization_id_or_slug}/config/integrations/": { "get": { "operationId": "Get Integration Provider Information", "description": "Get integration provider information about all available integrations for an organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "providerKey", "schema": { "type": "string" }, "description": "Specific integration provider to filter by such as `slack`. See our [Integrations Documentation](/product/integrations/) for an updated list of providers." } ], "tags": [ "Integrations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "providers": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "metadata": {}, "canAdd": { "type": "boolean" }, "canDisable": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "setupDialog": { "type": "object", "additionalProperties": {} } }, "required": [ "canAdd", "canDisable", "features", "key", "metadata", "name", "setupDialog", "slug" ] } } }, "required": [ "providers" ] }, "examples": { "GetIntegrationProviderInformationAboutAllAvailableIntegrationsForAlphabetSoupFactory": { "value": { "providers": [ { "key": "aws_lambda", "slug": "aws_lambda", "name": "AWS Lambda", "metadata": { "description": "The AWS Lambda integration will automatically instrument your Lambda functions without any code changes. We use CloudFormation Stack ([Learn more about CloudFormation](https://aws.amazon.com/cloudformation/)) to create Sentry role and enable errors and transactions capture from your Lambda functions.", "features": [ { "description": "Instrument your serverless code automatically.", "featureGate": "integrations-serverless" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=AWS%20Lambda%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/aws_lambda", "aspects": {} }, "canAdd": true, "canDisable": false, "features": [ "serverless" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/aws_lambda/setup/", "width": 600, "height": 600 } }, { "key": "bitbucket", "slug": "bitbucket", "name": "Bitbucket", "metadata": { "description": "Connect your Sentry organization to Bitbucket, enabling the following features:", "features": [ { "description": "Track commits and releases (learn more\n [here](https://docs.sentry.io/learn/releases/))", "featureGate": "integrations-commits" }, { "description": "Resolve Sentry issues via Bitbucket commits by\n including `Fixes PROJ-ID` in the message", "featureGate": "integrations-commits" }, { "description": "Create Bitbucket issues from Sentry", "featureGate": "integrations-issue-basic" }, { "description": "Link Sentry issues to existing Bitbucket issues", "featureGate": "integrations-issue-basic" }, { "description": "Link your Sentry stack traces back to your Bitbucket source code with stack\n trace linking.", "featureGate": "integrations-stacktrace-link" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Bitbucket%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/bitbucket", "aspects": {} }, "canAdd": true, "canDisable": false, "features": [ "issue-basic", "commits", "stacktrace-link" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/bitbucket/setup/", "width": 600, "height": 600 } }, { "key": "bitbucket_server", "slug": "bitbucket_server", "name": "Bitbucket Server", "metadata": { "description": "Connect your Sentry organization to Bitbucket Server, enabling the following features:", "features": [ { "description": "Track commits and releases (learn more\n [here](https://docs.sentry.io/learn/releases/))", "featureGate": "integrations-commits" }, { "description": "Resolve Sentry issues via Bitbucket Server commits by\n including `Fixes PROJ-ID` in the message", "featureGate": "integrations-commits" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Bitbucket%20Server%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/bitbucket_server", "aspects": {} }, "canAdd": true, "canDisable": false, "features": [ "commits" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/bitbucket_server/setup/", "width": 1030, "height": 1000 } }, { "key": "discord", "slug": "discord", "name": "Discord", "metadata": { "description": "Discord’s your place to collaborate, share, and just talk about your day – or\ncommiserate about app errors. Connect Sentry to your Discord server and get\n[alerts](https://docs.sentry.io/product/alerts/alert-types/) in a channel of your choice or via\ndirect message when sh%t hits the fan.", "features": [ { "description": "Assign, ignore, and resolve issues by interacting with chat messages.", "featureGate": "integrations-chat-unfurl" }, { "description": "Configure rule based Discord notifications to automatically be posted into a specific channel.", "featureGate": "integrations-alert-rule" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Discord%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/discord", "aspects": {} }, "canAdd": true, "canDisable": false, "features": [ "chat-unfurl", "alert-rule" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/discord/setup/", "width": 600, "height": 900 } }, { "key": "github", "slug": "github", "name": "GitHub", "metadata": { "description": "Connect your Sentry organization into your GitHub organization or user account.\nTake a step towards augmenting your sentry issues with commits from your\nrepositories ([using releases](https://docs.sentry.io/learn/releases/)) and\nlinking up your GitHub issues and pull requests directly to issues in Sentry.", "features": [ { "description": "Authorize repositories to be added to your Sentry organization to augment\n sentry issues with commit data with [deployment\n tracking](https://docs.sentry.io/learn/releases/).", "featureGate": "integrations-commits" }, { "description": "Create and link Sentry issue groups directly to a GitHub issue or pull\n request in any of your repositories, providing a quick way to jump from\n Sentry bug to tracked issue or PR.", "featureGate": "integrations-issue-basic" }, { "description": "Link your Sentry stack traces back to your GitHub source code with stack\n trace linking.", "featureGate": "integrations-stacktrace-link" }, { "description": "Import your GitHub [CODEOWNERS file](https://docs.sentry.io/product/integrations/source-code-mgmt/github/#code-owners) and use it alongside your ownership rules to assign Sentry issues.", "featureGate": "integrations-codeowners" }, { "description": "Automatically create GitHub issues based on Issue Alert conditions.", "featureGate": "integrations-ticket-rules" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=GitHub%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/github", "aspects": {} }, "canAdd": true, "canDisable": false, "features": [ "issue-basic", "commits", "codeowners", "stacktrace-link" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/github/setup/", "width": 1030, "height": 1000 } }, { "key": "github_enterprise", "slug": "github_enterprise", "name": "GitHub Enterprise", "metadata": { "description": "Connect your Sentry organization into your on-premises GitHub Enterprise\ninstances. Take a step towards augmenting your sentry issues with commits from\nyour repositories ([using releases](https://docs.sentry.io/learn/releases/))\nand linking up your GitHub issues and pull requests directly to issues in\nSentry.", "features": [ { "description": "Authorize repositories to be added to your Sentry organization to augment\n sentry issues with commit data with [deployment\n tracking](https://docs.sentry.io/learn/releases/).", "featureGate": "integrations-commits" }, { "description": "Create and link Sentry issue groups directly to a GitHub issue or pull\n request in any of your repositories, providing a quick way to jump from\n Sentry bug to tracked issue or PR.", "featureGate": "integrations-issue-basic" }, { "description": "Link your Sentry stack traces back to your GitHub source code with stack\n trace linking.", "featureGate": "integrations-stacktrace-link" }, { "description": "Import your GitHub [CODEOWNERS file](https://docs.sentry.io/product/integrations/source-code-mgmt/github/#code-owners) and use it alongside your ownership rules to assign Sentry issues.", "featureGate": "integrations-codeowners" }, { "description": "Automatically create GitHub issues based on Issue Alert conditions.", "featureGate": "integrations-ticket-rules" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=GitHub%20Enterprise%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/github_enterprise", "aspects": { "disable_dialog": { "actionText": "Visit GitHub Enterprise", "body": "Before deleting this integration, you must uninstall it from your GitHub Enterprise instance. After uninstalling, your integration will be disabled at which point you can choose to delete this integration." }, "removal_dialog": { "actionText": "Delete", "body": "Deleting this integration will delete all associated repositories and commit data. This action cannot be undone. Are you sure you want to delete your integration?" }, "alerts": [ { "type": "warning", "icon": "icon-warning-sm", "text": "Your GitHub enterprise instance must be able to communicate with Sentry. Before you proceed, make sure that connections from [the static set of IP addresses that Sentry makes outbound requests from](https://docs.sentry.io/product/security/ip-ranges/#outbound-requests) are allowed in your firewall." } ] } }, "canAdd": true, "canDisable": false, "features": [ "issue-basic", "commits", "codeowners", "stacktrace-link" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/github_enterprise/setup/", "width": 1030, "height": 1000 } }, { "key": "gitlab", "slug": "gitlab", "name": "GitLab", "metadata": { "description": "Connect your Sentry organization to an organization in your GitLab instance or gitlab.com, enabling the following features:", "features": [ { "description": "Track commits and releases (learn more\n [here](https://docs.sentry.io/learn/releases/))", "featureGate": "integrations-commits" }, { "description": "Resolve Sentry issues via GitLab commits and merge requests by\n including `Fixes PROJ-ID` in the message", "featureGate": "integrations-commits" }, { "description": "Create GitLab issues from Sentry", "featureGate": "integrations-issue-basic" }, { "description": "Link Sentry issues to existing GitLab issues", "featureGate": "integrations-issue-basic" }, { "description": "Link your Sentry stack traces back to your GitLab source code with stack\n trace linking.", "featureGate": "integrations-stacktrace-link" }, { "description": "Import your GitLab [CODEOWNERS file](https://docs.sentry.io/product/integrations/source-code-mgmt/gitlab/#code-owners) and use it alongside your ownership rules to assign Sentry issues.", "featureGate": "integrations-codeowners" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=GitLab%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/gitlab", "aspects": {} }, "canAdd": true, "canDisable": false, "features": [ "issue-basic", "commits", "codeowners", "stacktrace-link" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/gitlab/setup/", "width": 1030, "height": 1000 } }, { "key": "jira", "slug": "jira", "name": "Jira", "metadata": { "description": "Connect your Sentry organization into one or more of your Jira cloud instances.\nGet started streamlining your bug squashing workflow by unifying your Sentry and\nJira instances together.", "features": [ { "description": "Create and link Sentry issue groups directly to a Jira ticket in any of your\n projects, providing a quick way to jump from a Sentry bug to tracked ticket.", "featureGate": "integrations-issue-basic" }, { "description": "Automatically synchronize assignees to and from Jira. Don't get confused\n who's fixing what, let us handle ensuring your issues and tickets match up\n to your Sentry and Jira assignees.", "featureGate": "integrations-issue-sync" }, { "description": "Synchronize Comments on Sentry Issues directly to the linked Jira ticket.", "featureGate": "integrations-issue-sync" }, { "description": "Automatically create Jira tickets based on Issue Alert conditions.", "featureGate": "integrations-ticket-rules" } ], "author": "The Sentry Team", "noun": "Instance", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Jira%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/jira", "aspects": { "externalInstall": { "url": "https://marketplace.atlassian.com/apps/1219432/sentry-for-jira", "buttonText": "Jira Marketplace", "noticeText": "Visit the Jira Marketplace to install this integration. After installing the\nSentry add-on, access the settings panel in your Jira instance to enable the\nintegration for this Organization." } } }, "canAdd": false, "canDisable": false, "features": [ "issue-basic", "ticket-rules", "issue-sync" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/jira/setup/", "width": 600, "height": 600 } }, { "key": "jira_server", "slug": "jira_server", "name": "Jira Server", "metadata": { "description": "Connect your Sentry organization into one or more of your Jira Server instances.\nGet started streamlining your bug squashing workflow by unifying your Sentry and\nJira instances together.", "features": [ { "description": "Create and link Sentry issue groups directly to a Jira ticket in any of your\n projects, providing a quick way to jump from Sentry bug to tracked ticket.", "featureGate": "integrations-issue-basic" }, { "description": "Automatically synchronize assignees to and from Jira. Don't get confused\n who's fixing what, let us handle ensuring your issues and tickets match up\n to your Sentry and Jira assignees.", "featureGate": "integrations-issue-sync" }, { "description": "Synchronize Comments on Sentry Issues directly to the linked Jira ticket.", "featureGate": "integrations-issue-sync" }, { "description": "Automatically create Jira tickets based on Issue Alert conditions.", "featureGate": "integrations-ticket-rules" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Jira%20Server%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/jira_server", "aspects": { "alerts": [ { "type": "warning", "icon": "icon-warning-sm", "text": "Your Jira instance must be able to communicate with Sentry. Sentry makes outbound requests from a [static set of IP addresses](https://docs.sentry.io/ip-ranges/) that you may wish to allow in your firewall to support this integration." } ] } }, "canAdd": true, "canDisable": false, "features": [ "issue-basic", "issue-sync" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/jira_server/setup/", "width": 1030, "height": 1000 } }, { "key": "msteams", "slug": "msteams", "name": "Microsoft Teams", "metadata": { "description": "Microsoft Teams is a hub for teamwork in Office 365. Keep all your team's chats, meetings, files, and apps together in one place.\n\nGet [alerts](https://docs.sentry.io/product/alerts-notifications/alerts/) that let you assign, ignore, and resolve issues right in your Teams channels with the Sentry integration for Microsoft Teams.", "features": [ { "description": "Interact with messages in the chat to assign, ignore, and resolve issues.", "featureGate": "integrations-chat-unfurl" }, { "description": "Configure rule based Teams alerts to automatically be posted into a specific channel or user.", "featureGate": "integrations-alert-rule" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Microsoft%20Teams%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/msteams", "aspects": { "externalInstall": { "url": "https://teams.microsoft.com/l/app/5adee720-30de-4006-a342-d454317db1d4", "buttonText": "Teams Marketplace", "noticeText": "Visit the Teams Marketplace to install this integration. After adding the integration to your team, you will get a welcome message in the General channel to complete installation." } } }, "canAdd": false, "canDisable": false, "features": [ "chat-unfurl", "alert-rule" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/msteams/setup/", "width": 600, "height": 600 } }, { "key": "opsgenie", "slug": "opsgenie", "name": "Opsgenie", "metadata": { "description": "Trigger alerts in Opsgenie from Sentry.\n\nOpsgenie is a cloud-based service for dev and ops teams, providing reliable alerts, on-call schedule management, and escalations.\nOpsgenie integrates with monitoring tools and services to ensure that the right people are notified via email, SMS, phone, and iOS/Android push notifications.", "features": [ { "description": "Manage incidents and outages by sending Sentry notifications to Opsgenie.", "featureGate": "integrations-enterprise-incident-management" }, { "description": "Configure rule based Opsgenie alerts that automatically trigger and notify specific teams.", "featureGate": "integrations-enterprise-alert-rule" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/opsgenie", "aspects": {} }, "canAdd": true, "canDisable": false, "features": [ "incident-management", "alert-rule" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/opsgenie/setup/", "width": 600, "height": 600 } }, { "key": "pagerduty", "slug": "pagerduty", "name": "PagerDuty", "metadata": { "description": "Connect your Sentry organization with one or more PagerDuty accounts, and start getting\nincidents triggered from Sentry alerts.", "features": [ { "description": "Manage incidents and outages by sending Sentry notifications to PagerDuty.", "featureGate": "integrations-incident-management" }, { "description": "Configure rule based PagerDuty alerts to automatically be triggered in a specific\n service - or in multiple services!", "featureGate": "integrations-alert-rule" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=PagerDuty%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/pagerduty", "aspects": { "alerts": [ { "type": "info", "text": "The PagerDuty integration adds a new Alert Rule action to all projects. To enable automatic notifications sent to PagerDuty you must create a rule using the PagerDuty action in your project settings." } ] } }, "canAdd": true, "canDisable": false, "features": [ "incident-management", "alert-rule" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/pagerduty/setup/", "width": 600, "height": 900 } }, { "key": "slack", "slug": "slack", "name": "Slack", "metadata": { "description": "Connect your Sentry organization to one or more Slack workspaces, and start\ngetting errors right in front of you where all the action happens in your\noffice!", "features": [ { "description": "Unfurls Sentry URLs directly within Slack, providing you context and\n actionability on issues right at your fingertips. Resolve, ignore, and assign issues with minimal context switching.", "featureGate": "integrations-chat-unfurl" }, { "description": "Configure rule based Slack notifications to automatically be posted into a\n specific channel. Want any error that's happening more than 100 times a\n minute to be posted in `#critical-errors`? Setup a rule for it!", "featureGate": "integrations-alert-rule" } ], "author": "The Sentry Team", "noun": "Workspace", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Slack%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/slack", "aspects": { "alerts": [ { "type": "info", "text": "The Slack integration adds a new Alert Rule action to all projects. To enable automatic notifications sent to Slack you must create a rule using the slack workspace action in your project settings." } ] } }, "canAdd": true, "canDisable": false, "features": [ "chat-unfurl", "alert-rule" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/slack/setup/", "width": 600, "height": 900 } }, { "key": "vercel", "slug": "vercel", "name": "Vercel", "metadata": { "description": "Vercel is an all-in-one platform with Global CDN supporting static & JAMstack deployment and Serverless Functions.", "features": [ { "description": "Connect your Sentry and Vercel projects to automatically upload source maps and notify Sentry of new releases being deployed.", "featureGate": "integrations-deployment" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Vercel%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/vercel", "aspects": { "externalInstall": { "url": "https://vercel.com/integrations/sentry/add", "buttonText": "Vercel Marketplace", "noticeText": "Visit the Vercel Marketplace to install this integration. After installing the Sentry integration, you'll be redirected back to Sentry to finish syncing Vercel and Sentry projects." }, "configure_integration": { "title": "Connect Your Projects" } } }, "canAdd": false, "canDisable": false, "features": [ "deployment" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/vercel/setup/", "width": 600, "height": 600 } }, { "key": "vsts", "slug": "vsts", "name": "Azure DevOps", "metadata": { "description": "Connect your Sentry organization to one or more of your Azure DevOps\norganizations. Get started streamlining your bug squashing workflow by unifying\nyour Sentry and Azure DevOps organization together.", "features": [ { "description": "Authorize repositories to be added to your Sentry organization to augment\n sentry issues with commit data with [deployment\n tracking](https://docs.sentry.io/learn/releases/).", "featureGate": "integrations-commits" }, { "description": "Create and link Sentry issue groups directly to a Azure DevOps work item in any of\n your projects, providing a quick way to jump from Sentry bug to tracked\n work item.", "featureGate": "integrations-issue-basic" }, { "description": "Automatically synchronize comments and assignees to and from Azure DevOps. Don't get\n confused who's fixing what, let us handle ensuring your issues and work\n items match up to your Sentry and Azure DevOps assignees.", "featureGate": "integrations-issue-sync" }, { "description": "Never forget to close a resolved workitem! Resolving an issue in Sentry\n will resolve your linked workitems and vice versa.", "featureGate": "integrations-issue-sync" }, { "description": "Link your Sentry stack traces back to your Azure DevOps source code with stack\n trace linking.", "featureGate": "integrations-stacktrace-link" }, { "description": "Automatically create Azure DevOps work items based on Issue Alert conditions.", "featureGate": "integrations-ticket-rules" } ], "author": "The Sentry Team", "noun": "Installation", "issue_url": "https://github.com/getsentry/sentry/issues/new?assignees=&labels=Component:%20Integrations&template=bug.yml&title=Azure%20DevOps%20Integration%20Problem", "source_url": "https://github.com/getsentry/sentry/tree/master/src/sentry/integrations/vsts", "aspects": {} }, "canAdd": true, "canDisable": false, "features": [ "ticket-rules", "stacktrace-link", "issue-sync", "commits", "issue-basic" ], "setupDialog": { "url": "/organizations/devsentry-ecosystem/integrations/vsts/setup/", "width": 600, "height": 800 } } ] }, "summary": "Get integration provider information about all available integrations for Alphabet Soup Factory" } } } }, "description": "" }, "404": { "description": "Bad Request" } } } }, "/api/0/organizations/{organization_id_or_slug}/dashboards/": { "get": { "operationId": "List an Organization's Custom Dashboards", "description": "Retrieve a list of custom dashboards that are associated with the given organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Dashboards" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "dateCreated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "environment": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "properties": { "release": { "type": "array", "items": { "type": "string" } }, "releaseId": { "type": "array", "items": { "type": "string" } }, "globalFilter": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "lastVisited": { "type": "string", "nullable": true }, "widgetDisplay": { "type": "array", "items": { "type": "string" } }, "widgetPreview": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "permissions": { "type": "object", "properties": { "isEditableByEveryone": { "type": "boolean" }, "teamsWithEditAccess": { "type": "array", "items": { "type": "integer" } } }, "required": [ "isEditableByEveryone", "teamsWithEditAccess" ], "nullable": true }, "isFavorited": { "type": "boolean" }, "projects": { "type": "array", "items": { "type": "integer" } }, "prebuiltId": { "type": "integer", "nullable": true } }, "required": [ "createdBy", "dateCreated", "environment", "filters", "id", "isFavorited", "lastVisited", "permissions", "prebuiltId", "projects", "title", "widgetDisplay", "widgetPreview" ] } }, "examples": { "QueryDashboards": { "value": [ { "id": "1", "title": "Dashboard", "dateCreated": "2024-06-20T14:38:03.498574Z", "lastVisited": "2024-06-20T14:38:03.498574Z", "projects": [ 1 ], "environment": [ "alpha" ], "filters": { "release": [ "frontend@a02311a400636ff9640b3e4ca2991ee153dbbdcc", "frontend@36934c05140c16df93aa8ebf671f9386e916b501" ] }, "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } }, "widgetDisplay": [], "widgetPreview": [], "permissions": { "isEditableByEveryone": true, "teamsWithEditAccess": [] }, "isFavorited": false, "prebuiltId": null }, { "id": "2", "title": "Dashboard", "dateCreated": "2024-06-20T14:38:03.498574Z", "lastVisited": "2024-06-20T14:38:03.498574Z", "projects": [], "environment": [ "alpha" ], "filters": { "release": [ "frontend@a02311a400636ff9640b3e4ca2991ee153dbbdcc", "frontend@36934c05140c16df93aa8ebf671f9386e916b501" ] }, "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } }, "widgetDisplay": [], "widgetPreview": [], "permissions": null, "isFavorited": false, "prebuiltId": null } ], "summary": "Query Dashboards" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Create a New Dashboard for an Organization", "description": "Create a new dashboard for the given Organization", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "title": { "type": "string", "description": "The user defined title for this dashboard.", "maxLength": 255 }, "id": { "type": "string", "description": "A dashboard's unique id." }, "widgets": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "thresholds": { "type": "object", "additionalProperties": {}, "nullable": true }, "display_type": { "enum": [ "line", "area", "bar", "table", "big_number", "details", "categorical_bar", "wheel", "rage_and_dead_clicks", "server_tree", "text", "agents_traces_table" ], "type": "string", "description": "* `line`\n* `area`\n* `bar`\n* `table`\n* `big_number`\n* `details`\n* `categorical_bar`\n* `wheel`\n* `rage_and_dead_clicks`\n* `server_tree`\n* `text`\n* `agents_traces_table`" }, "interval": { "type": "string", "maxLength": 10 }, "queries": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "columns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "field_aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string" }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "is_hidden": { "type": "boolean" }, "on_demand_extraction": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "extraction_state": { "type": "string" }, "enabled": { "type": "boolean" } } }, "on_demand_extraction_disabled": { "type": "boolean" }, "selected_aggregate": { "type": "integer", "nullable": true }, "linked_dashboards": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "field": { "type": "string" }, "dashboard_id": { "type": "string" } }, "required": [ "dashboard_id", "field" ] }, "nullable": true } } } }, "widget_type": { "enum": [ "discover", "issue", "metrics", "error-events", "transaction-like", "spans", "logs", "tracemetrics", "preprod-app-size", null ], "type": "string", "description": "* `discover`\n* `issue`\n* `metrics`\n* `error-events`\n* `transaction-like`\n* `spans`\n* `logs`\n* `tracemetrics`\n* `preprod-app-size`", "nullable": true }, "limit": { "type": "integer", "minimum": 1, "nullable": true }, "layout": { "allOf": [ { "type": "object", "description": "Widget grid layout position and dimensions.\n\nThe dashboard uses a 6-column grid. Required keys: x, y, w, h, minH.\nConstraints: x (0-5), y (>= 0), w (1-6), h (>= 1), minH (>= 1), and x + w <= 6.", "properties": { "x": { "type": "integer", "maximum": 5, "minimum": 0, "description": "Column position (0-indexed)." }, "y": { "type": "integer", "minimum": 0, "description": "Row position (0-indexed)." }, "w": { "type": "integer", "maximum": 6, "minimum": 1, "description": "Width in grid columns (1-6)." }, "h": { "type": "integer", "minimum": 1, "description": "Height in grid rows." }, "min_h": { "type": "integer", "minimum": 1, "description": "Minimum height in grid rows." } }, "required": [ "h", "min_h", "w", "x", "y" ] } ], "nullable": true }, "axis_range": { "enum": [ "auto", "dataMin", null ], "type": "string", "description": "* `auto`\n* `dataMin`", "nullable": true }, "legend_type": { "enum": [ "default", "breakdown", null ], "type": "string", "description": "* `default`\n* `breakdown`", "nullable": true } } }, "description": "A json list of widgets saved in this dashboard." }, "projects": { "type": "array", "items": { "type": "integer" }, "description": "The saved projects filter for this dashboard." }, "environment": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The saved environment filter for this dashboard." }, "period": { "type": "string", "nullable": true, "description": "The saved time range period for this dashboard." }, "start": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved start time for this dashboard." }, "end": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved end time for this dashboard." }, "filters": { "type": "object", "additionalProperties": {}, "description": "The saved filters for this dashboard." }, "utc": { "type": "boolean", "description": "Setting that lets you display saved time range for this dashboard in UTC." }, "permissions": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "is_editable_by_everyone": { "type": "boolean", "description": "Whether the dashboard is editable by everyone." }, "teams_with_edit_access": { "type": "array", "items": { "type": "integer" }, "description": "List of team IDs that have edit access to a dashboard." } }, "required": [ "is_editable_by_everyone" ] } ], "nullable": true, "description": "Permissions that restrict users from editing dashboards" }, "is_favorited": { "type": "boolean", "default": false, "description": "Favorite the dashboard automatically for the request user" } }, "required": [ "title" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "period": { "type": "string" }, "utc": { "type": "string" }, "expired": { "type": "boolean" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "title": { "type": "string" }, "dateCreated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ], "nullable": true }, "widgets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "displayType": { "type": "string" }, "thresholds": { "type": "object", "properties": { "preferredPolarity": { "type": "string" }, "max_values": { "type": "object", "additionalProperties": { "type": "integer" } }, "unit": { "type": "string" } }, "required": [ "max_values", "unit" ], "nullable": true }, "interval": { "type": "string" }, "dateCreated": { "type": "string" }, "dashboardId": { "type": "string" }, "queries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "string" } }, "fieldAliases": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "widgetId": { "type": "string" }, "onDemand": { "type": "array", "items": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "extractionState": { "type": "string" }, "dashboardWidgetQueryId": { "type": "integer" } }, "required": [ "dashboardWidgetQueryId", "enabled", "extractionState" ] } }, "isHidden": { "type": "boolean" }, "selectedAggregate": { "type": "integer", "nullable": true }, "linkedDashboards": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "dashboardId": { "type": "integer" } }, "required": [ "dashboardId", "field" ] } } }, "required": [ "aggregates", "columns", "conditions", "fieldAliases", "fields", "id", "isHidden", "linkedDashboards", "name", "onDemand", "orderby", "selectedAggregate", "widgetId" ] } }, "limit": { "type": "integer", "nullable": true }, "widgetType": { "type": "string", "nullable": true }, "layout": { "type": "object", "additionalProperties": { "type": "integer" }, "nullable": true }, "axisRange": { "type": "string", "nullable": true }, "legendType": { "enum": [ "default", "breakdown" ], "type": "string", "nullable": true }, "datasetSource": { "type": "string", "nullable": true }, "exploreUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedReason": { "type": "array", "items": { "type": "object", "properties": { "orderby": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "equations": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "nullable": true }, "selected_columns": { "type": "array", "items": { "type": "string" } } }, "required": [ "equations", "orderby", "selected_columns" ] }, "nullable": true } }, "required": [ "axisRange", "changedReason", "dashboardId", "datasetSource", "dateCreated", "description", "displayType", "exploreUrls", "id", "interval", "layout", "legendType", "limit", "queries", "thresholds", "title", "widgetType" ] } }, "projects": { "type": "array", "items": { "type": "integer" } }, "filters": { "type": "object", "properties": { "release": { "type": "array", "items": { "type": "string" } }, "releaseId": { "type": "array", "items": { "type": "string" } }, "globalFilter": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "permissions": { "type": "object", "properties": { "isEditableByEveryone": { "type": "boolean" }, "teamsWithEditAccess": { "type": "array", "items": { "type": "integer" } } }, "required": [ "isEditableByEveryone", "teamsWithEditAccess" ], "nullable": true }, "isFavorited": { "type": "boolean" }, "prebuiltId": { "type": "integer", "nullable": true } }, "required": [ "createdBy", "dateCreated", "filters", "id", "isFavorited", "permissions", "prebuiltId", "projects", "title", "widgets" ] }, "examples": { "CreateDashboard": { "value": { "id": "1", "title": "Dashboard", "dateCreated": "2024-06-20T14:38:03.498574Z", "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } }, "widgets": [ { "id": "658714", "title": "Custom Widget", "description": null, "displayType": "table", "thresholds": null, "interval": "5m", "dateCreated": "2024-07-16T15:36:46.048343Z", "dashboardId": "1", "datasetSource": "user", "queries": [ { "id": "1", "name": "", "fields": [ "avg(transaction.duration)", "transaction" ], "aggregates": [ "avg(transaction.duration)" ], "columns": [ "transaction" ], "fieldAliases": [ "", "" ], "conditions": "", "orderby": "-avg(transaction.duration)", "widgetId": "1", "onDemand": [ { "enabled": false, "extractionState": "disabled:not-applicable", "dashboardWidgetQueryId": 1 } ], "isHidden": false, "selectedAggregate": null, "linkedDashboards": [] } ], "limit": null, "widgetType": "transaction-like", "layout": { "w": 2, "y": 0, "h": 2, "minH": 2, "x": 0 }, "exploreUrls": null, "changedReason": null, "axisRange": null, "legendType": "default" } ], "projects": [ 1 ], "filters": {}, "environment": [ "alpha" ], "period": "7d", "permissions": { "isEditableByEveryone": true, "teamsWithEditAccess": [] }, "isFavorited": false, "prebuiltId": null }, "summary": "Create Dashboard" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } } } }, "/api/0/organizations/{organization_id_or_slug}/dashboards/{dashboard_id}/": { "get": { "operationId": "Retrieve an Organization's Custom Dashboard", "description": "Return details about an organization's custom dashboard.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "dashboard_id", "schema": { "type": "integer" }, "description": "The ID of the dashboard you'd like to retrieve.", "required": true } ], "tags": [ "Dashboards" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "period": { "type": "string" }, "utc": { "type": "string" }, "expired": { "type": "boolean" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "title": { "type": "string" }, "dateCreated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ], "nullable": true }, "widgets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "displayType": { "type": "string" }, "thresholds": { "type": "object", "properties": { "preferredPolarity": { "type": "string" }, "max_values": { "type": "object", "additionalProperties": { "type": "integer" } }, "unit": { "type": "string" } }, "required": [ "max_values", "unit" ], "nullable": true }, "interval": { "type": "string" }, "dateCreated": { "type": "string" }, "dashboardId": { "type": "string" }, "queries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "string" } }, "fieldAliases": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "widgetId": { "type": "string" }, "onDemand": { "type": "array", "items": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "extractionState": { "type": "string" }, "dashboardWidgetQueryId": { "type": "integer" } }, "required": [ "dashboardWidgetQueryId", "enabled", "extractionState" ] } }, "isHidden": { "type": "boolean" }, "selectedAggregate": { "type": "integer", "nullable": true }, "linkedDashboards": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "dashboardId": { "type": "integer" } }, "required": [ "dashboardId", "field" ] } } }, "required": [ "aggregates", "columns", "conditions", "fieldAliases", "fields", "id", "isHidden", "linkedDashboards", "name", "onDemand", "orderby", "selectedAggregate", "widgetId" ] } }, "limit": { "type": "integer", "nullable": true }, "widgetType": { "type": "string", "nullable": true }, "layout": { "type": "object", "additionalProperties": { "type": "integer" }, "nullable": true }, "axisRange": { "type": "string", "nullable": true }, "legendType": { "enum": [ "default", "breakdown" ], "type": "string", "nullable": true }, "datasetSource": { "type": "string", "nullable": true }, "exploreUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedReason": { "type": "array", "items": { "type": "object", "properties": { "orderby": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "equations": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "nullable": true }, "selected_columns": { "type": "array", "items": { "type": "string" } } }, "required": [ "equations", "orderby", "selected_columns" ] }, "nullable": true } }, "required": [ "axisRange", "changedReason", "dashboardId", "datasetSource", "dateCreated", "description", "displayType", "exploreUrls", "id", "interval", "layout", "legendType", "limit", "queries", "thresholds", "title", "widgetType" ] } }, "projects": { "type": "array", "items": { "type": "integer" } }, "filters": { "type": "object", "properties": { "release": { "type": "array", "items": { "type": "string" } }, "releaseId": { "type": "array", "items": { "type": "string" } }, "globalFilter": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "permissions": { "type": "object", "properties": { "isEditableByEveryone": { "type": "boolean" }, "teamsWithEditAccess": { "type": "array", "items": { "type": "integer" } } }, "required": [ "isEditableByEveryone", "teamsWithEditAccess" ], "nullable": true }, "isFavorited": { "type": "boolean" }, "prebuiltId": { "type": "integer", "nullable": true } }, "required": [ "createdBy", "dateCreated", "filters", "id", "isFavorited", "permissions", "prebuiltId", "projects", "title", "widgets" ] }, "examples": { "DashboardGETResponse": { "value": { "id": "1", "title": "Dashboard", "dateCreated": "2024-06-20T14:38:03.498574Z", "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } }, "widgets": [ { "id": "658714", "title": "Custom Widget", "description": null, "displayType": "table", "thresholds": null, "interval": "5m", "dateCreated": "2024-07-16T15:36:46.048343Z", "dashboardId": "1", "datasetSource": "user", "queries": [ { "id": "1", "name": "", "fields": [ "avg(transaction.duration)", "transaction" ], "aggregates": [ "avg(transaction.duration)" ], "columns": [ "transaction" ], "fieldAliases": [ "", "" ], "conditions": "", "orderby": "-avg(transaction.duration)", "widgetId": "1", "onDemand": [ { "enabled": false, "extractionState": "disabled:not-applicable", "dashboardWidgetQueryId": 1 } ], "isHidden": false, "selectedAggregate": null, "linkedDashboards": [] } ], "limit": null, "widgetType": "transaction-like", "layout": { "w": 2, "y": 0, "h": 2, "minH": 2, "x": 0 }, "exploreUrls": null, "changedReason": null, "axisRange": null, "legendType": "default" } ], "projects": [ 1 ], "filters": {}, "environment": [ "alpha" ], "period": "7d", "permissions": { "isEditableByEveryone": true, "teamsWithEditAccess": [] }, "isFavorited": false, "prebuiltId": null }, "summary": "Dashboard GET response" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Edit an Organization's Custom Dashboard", "description": "Edit an organization's custom dashboard as well as any bulk\nedits on widgets that may have been made. (For example, widgets\nthat have been rearranged, updated queries and fields, specific\ndisplay types, and so on.)", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "dashboard_id", "schema": { "type": "integer" }, "description": "The ID of the dashboard you'd like to retrieve.", "required": true } ], "tags": [ "Dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string", "description": "A dashboard's unique id." }, "title": { "type": "string", "description": "The user-defined dashboard title.", "maxLength": 255 }, "widgets": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "thresholds": { "type": "object", "additionalProperties": {}, "nullable": true }, "display_type": { "enum": [ "line", "area", "bar", "table", "big_number", "details", "categorical_bar", "wheel", "rage_and_dead_clicks", "server_tree", "text", "agents_traces_table" ], "type": "string", "description": "* `line`\n* `area`\n* `bar`\n* `table`\n* `big_number`\n* `details`\n* `categorical_bar`\n* `wheel`\n* `rage_and_dead_clicks`\n* `server_tree`\n* `text`\n* `agents_traces_table`" }, "interval": { "type": "string", "maxLength": 10 }, "queries": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "columns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "field_aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string" }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "is_hidden": { "type": "boolean" }, "on_demand_extraction": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "extraction_state": { "type": "string" }, "enabled": { "type": "boolean" } } }, "on_demand_extraction_disabled": { "type": "boolean" }, "selected_aggregate": { "type": "integer", "nullable": true }, "linked_dashboards": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "field": { "type": "string" }, "dashboard_id": { "type": "string" } }, "required": [ "dashboard_id", "field" ] }, "nullable": true } } } }, "widget_type": { "enum": [ "discover", "issue", "metrics", "error-events", "transaction-like", "spans", "logs", "tracemetrics", "preprod-app-size", null ], "type": "string", "description": "* `discover`\n* `issue`\n* `metrics`\n* `error-events`\n* `transaction-like`\n* `spans`\n* `logs`\n* `tracemetrics`\n* `preprod-app-size`", "nullable": true }, "limit": { "type": "integer", "minimum": 1, "nullable": true }, "layout": { "allOf": [ { "type": "object", "description": "Widget grid layout position and dimensions.\n\nThe dashboard uses a 6-column grid. Required keys: x, y, w, h, minH.\nConstraints: x (0-5), y (>= 0), w (1-6), h (>= 1), minH (>= 1), and x + w <= 6.", "properties": { "x": { "type": "integer", "maximum": 5, "minimum": 0, "description": "Column position (0-indexed)." }, "y": { "type": "integer", "minimum": 0, "description": "Row position (0-indexed)." }, "w": { "type": "integer", "maximum": 6, "minimum": 1, "description": "Width in grid columns (1-6)." }, "h": { "type": "integer", "minimum": 1, "description": "Height in grid rows." }, "min_h": { "type": "integer", "minimum": 1, "description": "Minimum height in grid rows." } }, "required": [ "h", "min_h", "w", "x", "y" ] } ], "nullable": true }, "axis_range": { "enum": [ "auto", "dataMin", null ], "type": "string", "description": "* `auto`\n* `dataMin`", "nullable": true }, "legend_type": { "enum": [ "default", "breakdown", null ], "type": "string", "description": "* `default`\n* `breakdown`", "nullable": true } } }, "description": "A json list of widgets saved in this dashboard." }, "projects": { "type": "array", "items": { "type": "integer" }, "description": "The saved projects filter for this dashboard." }, "environment": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The saved environment filter for this dashboard." }, "period": { "type": "string", "nullable": true, "description": "The saved time range period for this dashboard." }, "start": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved start time for this dashboard." }, "end": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved end time for this dashboard." }, "filters": { "type": "object", "additionalProperties": {}, "description": "The saved filters for this dashboard." }, "utc": { "type": "boolean", "description": "Setting that lets you display saved time range for this dashboard in UTC." }, "permissions": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "is_editable_by_everyone": { "type": "boolean", "description": "Whether the dashboard is editable by everyone." }, "teams_with_edit_access": { "type": "array", "items": { "type": "integer" }, "description": "List of team IDs that have edit access to a dashboard." } }, "required": [ "is_editable_by_everyone" ] } ], "nullable": true, "description": "Permissions that restrict users from editing dashboards" } } } } } }, "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "period": { "type": "string" }, "utc": { "type": "string" }, "expired": { "type": "boolean" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "title": { "type": "string" }, "dateCreated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ], "nullable": true }, "widgets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "displayType": { "type": "string" }, "thresholds": { "type": "object", "properties": { "preferredPolarity": { "type": "string" }, "max_values": { "type": "object", "additionalProperties": { "type": "integer" } }, "unit": { "type": "string" } }, "required": [ "max_values", "unit" ], "nullable": true }, "interval": { "type": "string" }, "dateCreated": { "type": "string" }, "dashboardId": { "type": "string" }, "queries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "string" } }, "fieldAliases": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "widgetId": { "type": "string" }, "onDemand": { "type": "array", "items": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "extractionState": { "type": "string" }, "dashboardWidgetQueryId": { "type": "integer" } }, "required": [ "dashboardWidgetQueryId", "enabled", "extractionState" ] } }, "isHidden": { "type": "boolean" }, "selectedAggregate": { "type": "integer", "nullable": true }, "linkedDashboards": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "dashboardId": { "type": "integer" } }, "required": [ "dashboardId", "field" ] } } }, "required": [ "aggregates", "columns", "conditions", "fieldAliases", "fields", "id", "isHidden", "linkedDashboards", "name", "onDemand", "orderby", "selectedAggregate", "widgetId" ] } }, "limit": { "type": "integer", "nullable": true }, "widgetType": { "type": "string", "nullable": true }, "layout": { "type": "object", "additionalProperties": { "type": "integer" }, "nullable": true }, "axisRange": { "type": "string", "nullable": true }, "legendType": { "enum": [ "default", "breakdown" ], "type": "string", "nullable": true }, "datasetSource": { "type": "string", "nullable": true }, "exploreUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedReason": { "type": "array", "items": { "type": "object", "properties": { "orderby": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "equations": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "nullable": true }, "selected_columns": { "type": "array", "items": { "type": "string" } } }, "required": [ "equations", "orderby", "selected_columns" ] }, "nullable": true } }, "required": [ "axisRange", "changedReason", "dashboardId", "datasetSource", "dateCreated", "description", "displayType", "exploreUrls", "id", "interval", "layout", "legendType", "limit", "queries", "thresholds", "title", "widgetType" ] } }, "projects": { "type": "array", "items": { "type": "integer" } }, "filters": { "type": "object", "properties": { "release": { "type": "array", "items": { "type": "string" } }, "releaseId": { "type": "array", "items": { "type": "string" } }, "globalFilter": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "permissions": { "type": "object", "properties": { "isEditableByEveryone": { "type": "boolean" }, "teamsWithEditAccess": { "type": "array", "items": { "type": "integer" } } }, "required": [ "isEditableByEveryone", "teamsWithEditAccess" ], "nullable": true }, "isFavorited": { "type": "boolean" }, "prebuiltId": { "type": "integer", "nullable": true } }, "required": [ "createdBy", "dateCreated", "filters", "id", "isFavorited", "permissions", "prebuiltId", "projects", "title", "widgets" ] }, "examples": { "DashboardPUTResponse": { "value": { "id": "1", "title": "Dashboard", "dateCreated": "2024-06-20T14:38:03.498574Z", "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } }, "widgets": [ { "id": "658714", "title": "Custom Widget", "description": null, "displayType": "table", "thresholds": null, "interval": "5m", "dateCreated": "2024-07-16T15:36:46.048343Z", "dashboardId": "1", "datasetSource": "user", "queries": [ { "id": "1", "name": "", "fields": [ "avg(transaction.duration)", "transaction" ], "aggregates": [ "avg(transaction.duration)" ], "columns": [ "transaction" ], "fieldAliases": [ "", "" ], "conditions": "", "orderby": "-avg(transaction.duration)", "widgetId": "1", "onDemand": [ { "enabled": false, "extractionState": "disabled:not-applicable", "dashboardWidgetQueryId": 1 } ], "isHidden": false, "selectedAggregate": null, "linkedDashboards": [] } ], "limit": null, "widgetType": "transaction-like", "layout": { "w": 2, "y": 0, "h": 2, "minH": 2, "x": 0 }, "exploreUrls": null, "changedReason": null, "axisRange": null, "legendType": "default" } ], "projects": [ 1 ], "filters": {}, "environment": [ "alpha" ], "period": "7d", "permissions": { "isEditableByEveryone": true, "teamsWithEditAccess": [] }, "isFavorited": false, "prebuiltId": null }, "summary": "Dashboard PUT response" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete an Organization's Custom Dashboard", "description": "Delete an organization's custom dashboard.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "dashboard_id", "schema": { "type": "integer" }, "description": "The ID of the dashboard you'd like to retrieve.", "required": true } ], "tags": [ "Dashboards" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/detectors/": { "get": { "operationId": "Fetch an Organization's Monitors", "description": "List an Organization's Monitors", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "An optional search query for filtering monitors.\n\nAvailable fields are:\n- `name`\n- `type`: e.g. `error`, `metric_issue`, `issue_stream`\n- `assignee`: email, username, #team, me, none\n " }, { "in": "query", "name": "sortBy", "schema": { "type": "string" }, "description": "The property to sort results by. If not specified, the results are sorted by id.\n\nAvailable fields are:\n- `name`\n- `id`\n- `type`\n- `connectedWorkflows`\n- `latestGroup`\n- `openIssues`\n\nPrefix with `-` to sort in descending order.\n " }, { "in": "query", "name": "id", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the monitor you'd like to query." } ], "tags": [ "Monitors" ], "security": [ { "auth_token": [ "alerts:read", "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ], "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "latestGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "workflowIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dataSources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true }, "conditionGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "enabled": { "type": "boolean" }, "openIssues": { "type": "integer" } }, "required": [ "conditionGroup", "config", "dataSources", "dateCreated", "dateUpdated", "enabled", "id", "name", "openIssues", "projectId", "type", "workflowIds" ] } }, "examples": { "ListAllMonitorsInAnOrganization": { "value": [ { "id": "123", "projectId": "1", "name": "Error Monitor", "description": null, "type": "error", "workflowIds": [ "12345" ], "owner": null, "createdBy": null, "dateCreated": "2025-03-12T11:15:50.764865Z", "dateUpdated": "2025-06-17T14:04:02.485354Z", "dataSources": null, "conditionGroup": null, "config": {}, "enabled": true, "latestGroup": { "id": "123456789", "title": "This is an example Python exception", "culprit": "/api/0/test/example/", "shortId": "SENTRY-ABC12", "level": "info", "status": "unresolved", "substatus": "escalating", "platform": "python", "project": { "id": "1", "name": "Example", "slug": "sentry", "platform": "python" }, "type": "default", "issueType": "error", "issueCategory": "error", "metadata": { "title": "This is an example Python exception", "sdk": { "name": "sentry.python.django", "name_normalized": "sentry.python" }, "severity": 0, "severity_reason": "log_level_info", "initial_priority": 25 }, "numComments": 0, "firstSeen": "2026-01-08T21:00:59.737468Z", "lastSeen": "2026-01-08T21:23:45.723716Z" }, "openIssues": 100 }, { "id": "234567891", "projectId": "1", "name": "[us] Example", "description": null, "type": "uptime_domain_failure", "workflowIds": [], "owner": { "type": "team", "id": "1234", "name": "abc" }, "createdBy": null, "dateCreated": "2025-04-21T21:56:32.445528Z", "dateUpdated": "2025-10-23T00:07:24.809466Z", "dataSources": [ { "id": "271218", "organizationId": "1", "type": "uptime_subscription", "sourceId": "267409", "queryObj": { "url": "https://example.com", "method": "POST", "body": "{\n \"level\": \"info\",\n \"message\": \"Test-Event\",\n \"platform\": \"javascript\"\n}", "headers": [ [ "content-type", "application/json" ], [ "user-agent", "Sentry Test" ] ], "intervalSeconds": 60, "timeoutMs": 5000, "traceSampling": false } } ], "conditionGroup": { "id": "56789", "organizationId": "1", "logicType": "any", "conditions": [ { "id": "123456", "type": "eq", "comparison": "failure", "conditionResult": 75 }, { "id": "234567", "type": "eq", "comparison": "success", "conditionResult": 0 } ], "actions": [] }, "config": { "mode": 1, "environment": "us", "downtimeThreshold": 3, "recoveryThreshold": 1 }, "enabled": true, "latestGroup": null, "openIssues": 0 }, { "id": "1234567", "projectId": "123", "name": "Test Alert", "description": null, "type": "metric_issue", "workflowIds": [ "1234567" ], "owner": { "type": "user", "id": "12345", "name": "jane@example.com", "email": "jane@example.com" }, "createdBy": "12345", "dateCreated": "2025-04-28T22:46:12.469771Z", "dateUpdated": "2025-07-29T20:57:06.680844Z", "dataSources": [ { "id": "56789", "organizationId": "1", "type": "snuba_query_subscription", "sourceId": "45678", "queryObj": { "id": "34567", "status": 0, "subscription": "12/3456789", "snubaQuery": { "id": "56789", "dataset": "events_analytics_platform", "query": "", "aggregate": "avg(span.duration)", "timeWindow": 14400, "environment": null, "eventTypes": [ "trace_item_span" ], "extrapolationMode": "unknown" } } } ], "conditionGroup": { "id": "12345", "organizationId": "1", "logicType": "any", "conditions": [ { "id": "456789", "type": "gt", "comparison": 1600, "conditionResult": 75 }, { "id": "345678", "type": "lte", "comparison": 1600, "conditionResult": 0 } ], "actions": [] }, "config": { "detectionType": "static", "comparisonDelta": null }, "enabled": true, "latestGroup": null, "openIssues": 0 } ], "summary": "List all monitors in an organization" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Mutate an Organization's Monitors", "description": "Bulk enable or disable an Organization's Monitors", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "An optional search query for filtering monitors.\n\nAvailable fields are:\n- `name`\n- `type`: e.g. `error`, `metric_issue`, `issue_stream`\n- `assignee`: email, username, #team, me, none\n " }, { "in": "query", "name": "id", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the monitor you'd like to query." } ], "tags": [ "Monitors" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether to enable or disable the monitors" } }, "required": [ "enabled" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ], "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "latestGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "workflowIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dataSources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true }, "conditionGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "enabled": { "type": "boolean" }, "openIssues": { "type": "integer" } }, "required": [ "conditionGroup", "config", "dataSources", "dateCreated", "dateUpdated", "enabled", "id", "name", "openIssues", "projectId", "type", "workflowIds" ] } }, "examples": { "ListAllMonitorsInAnOrganization": { "value": [ { "id": "123", "projectId": "1", "name": "Error Monitor", "description": null, "type": "error", "workflowIds": [ "12345" ], "owner": null, "createdBy": null, "dateCreated": "2025-03-12T11:15:50.764865Z", "dateUpdated": "2025-06-17T14:04:02.485354Z", "dataSources": null, "conditionGroup": null, "config": {}, "enabled": true, "latestGroup": { "id": "123456789", "title": "This is an example Python exception", "culprit": "/api/0/test/example/", "shortId": "SENTRY-ABC12", "level": "info", "status": "unresolved", "substatus": "escalating", "platform": "python", "project": { "id": "1", "name": "Example", "slug": "sentry", "platform": "python" }, "type": "default", "issueType": "error", "issueCategory": "error", "metadata": { "title": "This is an example Python exception", "sdk": { "name": "sentry.python.django", "name_normalized": "sentry.python" }, "severity": 0, "severity_reason": "log_level_info", "initial_priority": 25 }, "numComments": 0, "firstSeen": "2026-01-08T21:00:59.737468Z", "lastSeen": "2026-01-08T21:23:45.723716Z" }, "openIssues": 100 }, { "id": "234567891", "projectId": "1", "name": "[us] Example", "description": null, "type": "uptime_domain_failure", "workflowIds": [], "owner": { "type": "team", "id": "1234", "name": "abc" }, "createdBy": null, "dateCreated": "2025-04-21T21:56:32.445528Z", "dateUpdated": "2025-10-23T00:07:24.809466Z", "dataSources": [ { "id": "271218", "organizationId": "1", "type": "uptime_subscription", "sourceId": "267409", "queryObj": { "url": "https://example.com", "method": "POST", "body": "{\n \"level\": \"info\",\n \"message\": \"Test-Event\",\n \"platform\": \"javascript\"\n}", "headers": [ [ "content-type", "application/json" ], [ "user-agent", "Sentry Test" ] ], "intervalSeconds": 60, "timeoutMs": 5000, "traceSampling": false } } ], "conditionGroup": { "id": "56789", "organizationId": "1", "logicType": "any", "conditions": [ { "id": "123456", "type": "eq", "comparison": "failure", "conditionResult": 75 }, { "id": "234567", "type": "eq", "comparison": "success", "conditionResult": 0 } ], "actions": [] }, "config": { "mode": 1, "environment": "us", "downtimeThreshold": 3, "recoveryThreshold": 1 }, "enabled": true, "latestGroup": null, "openIssues": 0 }, { "id": "1234567", "projectId": "123", "name": "Test Alert", "description": null, "type": "metric_issue", "workflowIds": [ "1234567" ], "owner": { "type": "user", "id": "12345", "name": "jane@example.com", "email": "jane@example.com" }, "createdBy": "12345", "dateCreated": "2025-04-28T22:46:12.469771Z", "dateUpdated": "2025-07-29T20:57:06.680844Z", "dataSources": [ { "id": "56789", "organizationId": "1", "type": "snuba_query_subscription", "sourceId": "45678", "queryObj": { "id": "34567", "status": 0, "subscription": "12/3456789", "snubaQuery": { "id": "56789", "dataset": "events_analytics_platform", "query": "", "aggregate": "avg(span.duration)", "timeWindow": 14400, "environment": null, "eventTypes": [ "trace_item_span" ], "extrapolationMode": "unknown" } } } ], "conditionGroup": { "id": "12345", "organizationId": "1", "logicType": "any", "conditions": [ { "id": "456789", "type": "gt", "comparison": 1600, "conditionResult": 75 }, { "id": "345678", "type": "lte", "comparison": 1600, "conditionResult": 0 } ], "actions": [] }, "config": { "detectionType": "static", "comparisonDelta": null }, "enabled": true, "latestGroup": null, "openIssues": 0 } ], "summary": "List all monitors in an organization" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Bulk Delete Monitors", "description": "Bulk delete Monitors for a given organization", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "An optional search query for filtering monitors.\n\nAvailable fields are:\n- `name`\n- `type`: e.g. `error`, `metric_issue`, `issue_stream`\n- `assignee`: email, username, #team, me, none\n " }, { "in": "query", "name": "sortBy", "schema": { "type": "string" }, "description": "The property to sort results by. If not specified, the results are sorted by id.\n\nAvailable fields are:\n- `name`\n- `id`\n- `type`\n- `connectedWorkflows`\n- `latestGroup`\n- `openIssues`\n\nPrefix with `-` to sort in descending order.\n " }, { "in": "query", "name": "id", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the monitor you'd like to query." } ], "tags": [ "Monitors" ], "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "description": "Success" }, "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/detectors/{detector_id}/": { "get": { "operationId": "Fetch a Monitor", "description": "Return details on an individual monitor", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "detector_id", "schema": { "type": "integer" }, "description": "The ID of the monitor you'd like to query.", "required": true } ], "tags": [ "Monitors" ], "security": [ { "auth_token": [ "alerts:read", "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ], "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "latestGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "workflowIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dataSources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true }, "conditionGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "enabled": { "type": "boolean" }, "openIssues": { "type": "integer" } }, "required": [ "conditionGroup", "config", "dataSources", "dateCreated", "dateUpdated", "enabled", "id", "name", "openIssues", "projectId", "type", "workflowIds" ] }, "examples": { "FetchAMonitor": { "value": { "id": "123456", "projectId": "1", "name": "High Number of Errors", "description": null, "type": "metric_issue", "workflowIds": [ "45678" ], "owner": { "type": "team", "id": "1234567", "name": "example-team" }, "createdBy": "789123", "dateCreated": "2025-03-25T17:50:45.587657Z", "dateUpdated": "2025-07-22T17:10:45.069457Z", "dataSources": [ { "id": "34567", "organizationId": "1", "type": "snuba_query_subscription", "sourceId": "56789", "queryObj": { "id": "23456", "status": 0, "subscription": "12/345acb678def912ghi", "snubaQuery": { "id": "12345", "dataset": "events", "query": "", "aggregate": "count()", "timeWindow": 900, "environment": null, "eventTypes": [ "error" ], "extrapolationMode": "unknown" } } } ], "conditionGroup": { "id": "345678", "organizationId": "1", "logicType": "any", "conditions": [ { "id": "234567", "type": "anomaly_detection", "comparison": { "seasonality": "auto", "sensitivity": "low", "thresholdType": 0 }, "conditionResult": 75 } ], "actions": [] }, "config": { "detectionType": "dynamic", "comparisonDelta": null }, "enabled": true, "latestGroup": { "id": "123456789", "title": "High Number of Errors", "culprit": "", "shortId": "EXAMPLE-1A2B", "level": "error", "status": "resolved", "substatus": null, "platform": "python", "project": { "id": "1", "name": "Backend", "slug": "sentry", "platform": "python" }, "type": "generic", "issueType": "metric_issue", "issueCategory": "metric", "metadata": { "title": "High Number of Errors", "value": "Detected an error", "initial_priority": 75 }, "numComments": 0, "firstSeen": "2025-07-21T14:46:07.845207Z", "lastSeen": "2026-01-12T16:16:26.355334Z" }, "openIssues": 0 }, "summary": "Fetch a Monitor" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update a Monitor by ID", "description": "Update an existing monitor", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "detector_id", "schema": { "type": "integer" }, "description": "The ID of the monitor you'd like to query.", "required": true } ], "tags": [ "Monitors" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "name": { "type": "string", "description": "Name of the monitor.", "maxLength": 200 }, "type": { "type": "string", "description": "The type of monitor - `metric_issue`." }, "workflow_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the alerts to connect this monitor to. Use the 'Fetch Alerts' endpoint to find the IDs." }, "data_sources": { "type": "array", "items": {}, "description": "\n The data sources for the monitor to use based on what you want to measure.\n\n **Number of Errors Metric Monitor**\n - `eventTypes`: Any of `error` or `default`.\n ```json\n [\n {\n \"aggregate\": \"count()\",\n \"dataset\" : \"events\",\n \"environment\": \"prod\",\n \"eventTypes\": [\"default\", \"error\"],\n \"query\": \"is:unresolved\",\n \"queryType\": 0,\n \"timeWindow\": 3600,\n },\n ],\n ```\n\n **Users Experiencing Errors Metric Monitor**\n - `eventTypes`: Any of `error` or `default`.\n ```json\n [\n {\n \"aggregate\": \"count_unique(tags[sentry:user])\",\n \"dataset\" : \"events\",\n \"environment\": \"prod\",\n \"eventTypes\": [\"default\", \"error\"],\n \"query\": \"is:unresolved\",\n \"queryType\": 0,\n \"timeWindow\": 3600,\n },\n ],\n ```\n\n\n **Throughput Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"count(span.duration)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Duration Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"p95(span.duration)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Failure Rate Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"failure_rate()\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Largest Contentful Paint Metric Monitor**\n - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.\n - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile.\n\n ```json\n [\n {\n \"aggregate\":\"p95(measurements.lcp)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Custom Metric Monitor**\n - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.\n - `aggregate`: Valid values are:\n `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p75(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile.\n `failure_rate()`\n `apdex(x)`, where `x` is the value of the Apdex score.\n `count()`\n\n ```json\n [\n {\n \"aggregate\": \"p75(measurements.ttfb)\"\n \"dataset\": \"events_analytics_platform\",\n \"queryType\": 1,\n },\n ],\n" }, "config": { "type": "object", "additionalProperties": {}, "description": "\n The issue detection type configuration.\n\n\n - `detectionType`\n - `static`: Threshold based monitor\n - `percent`: Change based monitor\n - `dynamic`: Dynamic monitor\n - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes.\n For example, a value of 3600 compares the metric tracked against data 1 hour ago.\n - `300`: 5 minutes\n - `900`: 15 minutes\n - `3600`: 1 hour\n - `86400`: 1 day\n - `604800`: 1 week\n - `2592000`: 1 month\n\n **Threshold**\n ```json\n {\n \"detectionType\": \"static\",\n }\n ```\n **Change**\n ```json\n {\n \"detectionType\": \"percent\",\n \"comparisonDelta\": 3600,\n }\n ```\n **Dynamic**\n ```json\n {\n \"detectionType\": \"dynamic\",\n }\n ```\n " }, "condition_group": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "logic_type": { "enum": [ "any", "any-short", "all", "none" ], "type": "string", "description": "* `any`\n* `any-short`\n* `all`\n* `none`" }, "conditions": { "type": "array", "items": {} } }, "required": [ "logic_type" ] } ], "description": "\n Issue detection configuration for when to create an issue and at what priority level.\n\n\n - `logicType`: `any`\n - `type`: Any of `gt` (greater than), `lte` (less than or equal), or `anomaly_detection` (dynamic)\n - `comparison`: Any positive integer. This is threshold that must be crossed for the monitor to create an issue, e.g. \"Create a metric issue when there are more than 5 unresolved error events\".\n - If creating a **dynamic** monitor, see the options below.\n - `seasonality`: `auto`\n - `sensitivity`: Level of responsiveness. Options are one of `low`, `medium`, or `high`\n - `thresholdType`: If you want to be alerted to anomalies that are moving above, below, or in both directions in relation to your threshold.\n - `0`: Above\n - `1`: Below\n - `2`: Above and below\n\n - `conditionResult`: The issue state change when the threshold is crossed.\n - `75`: High priority\n - `50`: Low priority\n - `0`: Resolved\n\n\n **Threshold and Change Monitor**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"gt\",\n \"comparison\": 10,\n \"conditionResult\": 75\n },\n {\n \"type\": \"lte\",\n \"comparison\": 10,\n \"conditionResult\": 0\n }\n ],\n \"actions\": []\n ```\n\n **Threshold Monitor with Medium Priority**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n type: \"gt\",\n comparison: 5,\n conditionResult: 75\n },\n {\n type: \"gt\",\n comparison: 2,\n conditionResult: 50\n },\n {\n type: \"lte\",\n comparison: 2,\n conditionResult: 0\n }\n ],\n \"actions\": []\n ```\n\n **Dynamic Monitor**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"anomaly_detection\",\n \"comparison\": {\n \"seasonality\": \"auto\",\n \"sensitivity\": \"medium\",\n \"thresholdType\": 2\n },\n \"conditionResult\": 75\n }\n ],\n \"actions\": []\n ```\n " }, "owner": { "type": "string", "nullable": true, "description": "\n The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'.\n\n **User**\n ```json\n \"user:123456\"\n ```\n\n **Team**\n ```json\n \"team:456789\"\n ```\n " }, "description": { "type": "string", "nullable": true, "description": "A description of the monitor. Will be used in the resulting issue." }, "enabled": { "type": "boolean", "description": "Set to False if you want to disable the monitor." } }, "required": [ "name", "type" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ], "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "latestGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "workflowIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dataSources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true }, "conditionGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "enabled": { "type": "boolean" }, "openIssues": { "type": "integer" } }, "required": [ "conditionGroup", "config", "dataSources", "dateCreated", "dateUpdated", "enabled", "id", "name", "openIssues", "projectId", "type", "workflowIds" ] }, "examples": { "UpdateAMonitor": { "value": { "id": "12345", "projectId": "1", "name": "Updated monitor", "description": null, "type": "metric_issue", "workflowIds": [], "owner": { "type": "user", "id": "4567", "name": "Jane Doe", "email": "jane@example.io" }, "createdBy": "45678", "dateCreated": "2026-01-09T18:47:41.596427Z", "dateUpdated": "2026-01-12T21:30:07.354861Z", "dataSources": [ { "id": "2345", "organizationId": "1", "type": "snuba_query_subscription", "sourceId": "1234", "queryObj": { "id": "3456", "status": 0, "subscription": "55/abc123def456ghi789", "snubaQuery": { "id": "56789", "dataset": "events_analytics_platform", "query": "", "aggregate": "p95(measurements.lcp)", "timeWindow": 3600, "environment": null, "eventTypes": [ "trace_item_span" ], "extrapolationMode": "unknown" } } } ], "conditionGroup": { "id": "12345678", "organizationId": "1", "logicType": "any", "conditions": [ { "id": "234567", "type": "gt", "comparison": 5, "conditionResult": 75 }, { "id": "234568", "type": "lte", "comparison": 5, "conditionResult": 0 } ], "actions": [] }, "config": { "detectionType": "static" }, "enabled": true, "latestGroup": { "id": "123456789", "title": "Test monitor", "culprit": "", "shortId": "SENTRY-1A2B", "level": "error", "status": "resolved", "substatus": null, "platform": "python", "project": { "id": "1", "name": "Backend", "slug": "sentry", "platform": "python" }, "type": "generic", "issueType": "metric_issue", "issueCategory": "metric", "metadata": { "title": "Test monitor", "value": "Critical: Number of events in the last hour above 5", "initial_priority": 75 }, "numComments": 0, "firstSeen": "2026-01-09T18:48:15.250134Z", "lastSeen": "2026-01-09T18:48:15.250134Z" }, "openIssues": 0 }, "summary": "Update a Monitor" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete a Monitor", "description": "Delete a monitor", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "detector_id", "schema": { "type": "integer" }, "description": "The ID of the monitor you'd like to query.", "required": true } ], "tags": [ "Monitors" ], "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:read", "org:write" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/discover/saved/": { "get": { "operationId": "List an Organization's Discover Saved Queries", "description": "Retrieve a list of saved queries that are associated with the given organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "The name of the Discover query you'd like to filter by." }, { "in": "query", "name": "sortBy", "schema": { "type": "string" }, "description": "The property to sort results by. If not specified, the results are sorted by query name.\n\nAvailable fields are:\n- `name`\n- `dateCreated`\n- `dateUpdated`\n- `mostPopular`\n- `recentlyViewed`\n- `myqueries`\n " } ], "tags": [ "Discover" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "widths": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "array", "items": { "type": "string" } }, "aggregations": { "type": "array", "items": { "type": "string" } }, "range": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "orderby": { "type": "string" }, "limit": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "display": { "type": "string" }, "topEvents": { "type": "integer" }, "interval": { "type": "string" }, "exploreQuery": { "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "integer" } }, "version": { "type": "integer" }, "queryDataset": { "type": "string" }, "datasetSource": { "type": "string" }, "expired": { "type": "boolean" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] } }, "required": [ "createdBy", "datasetSource", "dateCreated", "dateUpdated", "expired", "id", "name", "projects", "queryDataset", "version" ] } }, "examples": { "GetDiscoverSavedQueries": { "value": [ { "id": "1", "name": "Transactions by Volume", "projects": [], "version": 2, "queryDataset": "transaction-like", "datasetSource": "unknown", "expired": false, "dateCreated": "2024-07-25T19:35:38.422859Z", "dateUpdated": "2024-07-25T19:35:38.422874Z", "environment": [], "query": "", "fields": [ "id", "transaction", "timestamp" ], "widths": [], "range": "24h", "orderby": "-timestamp", "yAxis": [ "count()" ], "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } } }, { "id": "2", "name": "All Events", "projects": [], "version": 2, "queryDataset": "transaction-like", "datasetSource": "unknown", "expired": false, "dateCreated": "2024-07-25T19:35:38.422859Z", "dateUpdated": "2024-07-25T19:35:38.422874Z", "environment": [], "query": "transaction:/api/foo", "fields": [ "transaction", "project", "count()", "avg(transaction.duration)", "p75()", "p95()" ], "widths": [], "range": "24h", "orderby": "-count", "yAxis": [ "count()" ], "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } } } ], "summary": "Get Discover Saved Queries" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Create a New Saved Query", "description": "Create a new saved query for the given organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Discover" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The user-defined saved query name.", "maxLength": 255 }, "projects": { "type": "array", "items": { "type": "integer" }, "description": "The saved projects filter for this query." }, "queryDataset": { "enum": [ "discover", "error-events", "transaction-like" ], "type": "string", "default": "error-events", "description": "The dataset you would like to query. Note: `discover` is a **deprecated** value. The allowed values are: `error-events`, `transaction-like`\n\n* `discover`\n* `error-events`\n* `transaction-like`" }, "start": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved start time for this saved query." }, "end": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved end time for this saved query." }, "range": { "type": "string", "nullable": true, "description": "The saved time range period for this saved query." }, "fields": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The fields, functions, or equations that can be requested for the query. At most 20 fields can be selected per request. Each field can be one of the following types:\n- A built-in key field. See possible fields in the [properties table](/product/sentry-basics/search/searchable-properties/#properties-table), under any field that is an event property.\n - example: `field=transaction`\n- A tag. Tags should use the `tag[]` formatting to avoid ambiguity with any fields\n - example: `field=tag[isEnterprise]`\n- A function which will be in the format of `function_name(parameters,...)`. See possible functions in the [query builder documentation](/product/discover-queries/query-builder/#stacking-functions).\n - when a function is included, Discover will group by any tags or fields\n - example: `field=count_if(transaction.duration,greater,300)`\n- An equation when prefixed with `equation|`. Read more about [equations here](/product/discover-queries/query-builder/query-equations/).\n - example: `field=equation|count_if(transaction.duration,greater,300) / count() * 100`\n" }, "orderby": { "type": "string", "nullable": true, "description": "How to order the query results. Must be something in the `field` list, excluding equations." }, "environment": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The name of environments to filter by." }, "query": { "type": "string", "nullable": true, "description": "Filters results by using [query syntax](/product/sentry-basics/search/)." }, "yAxis": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Aggregate functions to be plotted on the chart." }, "display": { "type": "string", "nullable": true, "description": "Visualization type for saved query chart. Allowed values are:\n- default\n- previous\n- top5\n- daily\n- dailytop5\n- bar\n" }, "topEvents": { "type": "integer", "maximum": 10, "minimum": 1, "nullable": true, "description": "Number of top events' timeseries to be visualized." }, "interval": { "type": "string", "nullable": true, "description": "Resolution of the time series." } }, "required": [ "name" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "widths": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "array", "items": { "type": "string" } }, "aggregations": { "type": "array", "items": { "type": "string" } }, "range": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "orderby": { "type": "string" }, "limit": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "display": { "type": "string" }, "topEvents": { "type": "integer" }, "interval": { "type": "string" }, "exploreQuery": { "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "integer" } }, "version": { "type": "integer" }, "queryDataset": { "type": "string" }, "datasetSource": { "type": "string" }, "expired": { "type": "boolean" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] } }, "required": [ "createdBy", "datasetSource", "dateCreated", "dateUpdated", "expired", "id", "name", "projects", "queryDataset", "version" ] }, "examples": { "CreateDiscoverSavedQuery": { "value": { "id": "1", "name": "Transactions by Volume", "projects": [], "version": 2, "queryDataset": "transaction-like", "datasetSource": "unknown", "expired": false, "dateCreated": "2024-07-25T19:35:38.422859Z", "dateUpdated": "2024-07-25T19:35:38.422874Z", "environment": [], "query": "transaction:/api/foo", "fields": [ "transaction", "project", "count()", "avg(transaction.duration)", "p75()", "p95()" ], "widths": [], "range": "24h", "orderby": "-count", "yAxis": [ "count()" ], "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } } }, "summary": "Create Discover Saved Query" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/discover/saved/{query_id}/": { "get": { "operationId": "Retrieve an Organization's Discover Saved Query", "description": "Retrieve a saved query.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "query_id", "schema": { "type": "integer" }, "description": "The ID of the Discover query you'd like to retrieve.", "required": true } ], "tags": [ "Discover" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "widths": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "array", "items": { "type": "string" } }, "aggregations": { "type": "array", "items": { "type": "string" } }, "range": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "orderby": { "type": "string" }, "limit": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "display": { "type": "string" }, "topEvents": { "type": "integer" }, "interval": { "type": "string" }, "exploreQuery": { "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "integer" } }, "version": { "type": "integer" }, "queryDataset": { "type": "string" }, "datasetSource": { "type": "string" }, "expired": { "type": "boolean" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] } }, "required": [ "createdBy", "datasetSource", "dateCreated", "dateUpdated", "expired", "id", "name", "projects", "queryDataset", "version" ] }, "examples": { "DiscoverSavedQueryGETResponse": { "value": { "id": "1", "name": "Transactions by Volume", "projects": [], "version": 2, "queryDataset": "transaction-like", "datasetSource": "unknown", "expired": false, "dateCreated": "2024-07-25T19:35:38.422859Z", "dateUpdated": "2024-07-25T19:35:38.422874Z", "environment": [], "query": "transaction:/api/foo", "fields": [ "transaction", "project", "count()", "avg(transaction.duration)", "p75()", "p95()" ], "widths": [], "range": "24h", "orderby": "-count", "yAxis": [ "count()" ], "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } } }, "summary": "Discover Saved Query GET response" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Edit an Organization's Discover Saved Query", "description": "Modify a saved query.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "query_id", "schema": { "type": "integer" }, "description": "The ID of the Discover query you'd like to retrieve.", "required": true } ], "tags": [ "Discover" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The user-defined saved query name.", "maxLength": 255 }, "projects": { "type": "array", "items": { "type": "integer" }, "description": "The saved projects filter for this query." }, "queryDataset": { "enum": [ "discover", "error-events", "transaction-like" ], "type": "string", "default": "error-events", "description": "The dataset you would like to query. Note: `discover` is a **deprecated** value. The allowed values are: `error-events`, `transaction-like`\n\n* `discover`\n* `error-events`\n* `transaction-like`" }, "start": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved start time for this saved query." }, "end": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved end time for this saved query." }, "range": { "type": "string", "nullable": true, "description": "The saved time range period for this saved query." }, "fields": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The fields, functions, or equations that can be requested for the query. At most 20 fields can be selected per request. Each field can be one of the following types:\n- A built-in key field. See possible fields in the [properties table](/product/sentry-basics/search/searchable-properties/#properties-table), under any field that is an event property.\n - example: `field=transaction`\n- A tag. Tags should use the `tag[]` formatting to avoid ambiguity with any fields\n - example: `field=tag[isEnterprise]`\n- A function which will be in the format of `function_name(parameters,...)`. See possible functions in the [query builder documentation](/product/discover-queries/query-builder/#stacking-functions).\n - when a function is included, Discover will group by any tags or fields\n - example: `field=count_if(transaction.duration,greater,300)`\n- An equation when prefixed with `equation|`. Read more about [equations here](/product/discover-queries/query-builder/query-equations/).\n - example: `field=equation|count_if(transaction.duration,greater,300) / count() * 100`\n" }, "orderby": { "type": "string", "nullable": true, "description": "How to order the query results. Must be something in the `field` list, excluding equations." }, "environment": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The name of environments to filter by." }, "query": { "type": "string", "nullable": true, "description": "Filters results by using [query syntax](/product/sentry-basics/search/)." }, "yAxis": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Aggregate functions to be plotted on the chart." }, "display": { "type": "string", "nullable": true, "description": "Visualization type for saved query chart. Allowed values are:\n- default\n- previous\n- top5\n- daily\n- dailytop5\n- bar\n" }, "topEvents": { "type": "integer", "maximum": 10, "minimum": 1, "nullable": true, "description": "Number of top events' timeseries to be visualized." }, "interval": { "type": "string", "nullable": true, "description": "Resolution of the time series." } }, "required": [ "name" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "widths": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "array", "items": { "type": "string" } }, "aggregations": { "type": "array", "items": { "type": "string" } }, "range": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "orderby": { "type": "string" }, "limit": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "display": { "type": "string" }, "topEvents": { "type": "integer" }, "interval": { "type": "string" }, "exploreQuery": { "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "integer" } }, "version": { "type": "integer" }, "queryDataset": { "type": "string" }, "datasetSource": { "type": "string" }, "expired": { "type": "boolean" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] } }, "required": [ "createdBy", "datasetSource", "dateCreated", "dateUpdated", "expired", "id", "name", "projects", "queryDataset", "version" ] }, "examples": { "DiscoverSavedQueryGETResponse": { "value": { "id": "1", "name": "Transactions by Volume", "projects": [], "version": 2, "queryDataset": "transaction-like", "datasetSource": "unknown", "expired": false, "dateCreated": "2024-07-25T19:35:38.422859Z", "dateUpdated": "2024-07-25T19:35:38.422874Z", "environment": [], "query": "transaction:/api/foo", "fields": [ "transaction", "project", "count()", "avg(transaction.duration)", "p75()", "p95()" ], "widths": [], "range": "24h", "orderby": "-count", "yAxis": [ "count()" ], "createdBy": { "id": "1", "name": "Admin", "username": "admin", "email": "admin@sentry.io", "avatarUrl": "www.example.com", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-10-25T17:07:33.190596Z", "lastLogin": "2024-07-16T15:28:39.261659Z", "has2fa": true, "lastActive": "2024-07-16T20:45:49.364197Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "1", "email": "admin@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null, "avatarUrl": "www.example.com" } } }, "summary": "Discover Saved Query GET response" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete an Organization's Discover Saved Query", "description": "Delete a saved query.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "query_id", "schema": { "type": "integer" }, "description": "The ID of the Discover query you'd like to retrieve.", "required": true } ], "tags": [ "Discover" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/environments/": { "get": { "operationId": "List an Organization's Environments", "description": "Lists an organization's environments.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "visibility", "schema": { "type": "string", "enum": [ "all", "hidden", "visible" ] }, "description": "The visibility of the environments to filter by. Defaults to `visible`." } ], "tags": [ "Environments" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "examples": { "ListAnOrganization'sEnvironments": { "value": [ { "id": "1", "name": "Production" }, { "id": "2", "name": "Staging" } ], "summary": "List an Organization's Environments" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/eventids/{event_id}/": { "get": { "operationId": "Resolve an Event ID", "description": "This resolves an event ID to the project slug and internal issue ID and internal event ID.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "event_id", "schema": { "type": "string" }, "description": "The event ID to look up.", "required": true } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationSlug": { "type": "string" }, "projectSlug": { "type": "string" }, "groupId": { "type": "string" }, "eventId": { "type": "string" }, "event": { "type": "object", "properties": { "id": { "type": "string" }, "groupID": { "type": "string", "nullable": true }, "eventID": { "type": "string" }, "projectID": { "type": "string" }, "message": { "type": "string", "nullable": true }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "geo": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "nullable": true }, "tags": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "platform": { "type": "string" }, "dateReceived": { "type": "string", "format": "date-time", "nullable": true }, "contexts": { "type": "object", "additionalProperties": {}, "nullable": true }, "size": { "type": "integer", "nullable": true }, "entries": { "type": "array", "items": {} }, "dist": { "type": "string", "nullable": true }, "sdk": { "type": "object", "additionalProperties": { "type": "string" } }, "context": { "type": "object", "additionalProperties": {}, "nullable": true }, "packages": { "type": "object", "additionalProperties": {} }, "type": { "type": "string" }, "metadata": {}, "errors": { "type": "array", "items": {} }, "occurrence": {}, "_meta": { "type": "object", "additionalProperties": {} }, "crashFile": { "type": "string", "nullable": true }, "culprit": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "fingerprints": { "type": "array", "items": { "type": "string" } }, "groupingConfig": {}, "startTimestamp": { "type": "string", "format": "date-time" }, "endTimestamp": { "type": "string", "format": "date-time" }, "measurements": {}, "breakdowns": {} }, "required": [ "_meta", "context", "contexts", "dateReceived", "dist", "entries", "errors", "eventID", "groupID", "id", "location", "message", "metadata", "occurrence", "packages", "platform", "projectID", "sdk", "size", "tags", "title", "type", "user" ] } }, "required": [ "event", "eventId", "groupId", "organizationSlug", "projectSlug" ] }, "examples": { "EventExample": { "value": { "event": { "_meta": { "context": null, "contexts": null, "entries": {}, "message": null, "packages": null, "sdk": null, "tags": {}, "user": null }, "context": { "length": 10837790, "results": [ 1, 2, 3, 4, 5 ], "session": { "foo": "bar" }, "unauthorized": false, "url": "http://example.org/foo/bar/" }, "contexts": {}, "dateCreated": "2018-11-06T21:19:55Z", "dateReceived": "2018-11-06T21:19:55Z", "dist": null, "entries": [ { "type": "request", "data": { "fragment": null, "cookies": [], "inferredContentType": null, "env": null, "headers": [ [ "User-Agent", "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36" ] ], "url": "http://example.com/foo", "query": [], "data": null, "method": null } } ], "errors": [], "eventID": "9fac2ceed9344f2bbfdd1fdacb0ed9b1", "fingerprints": [ "c4a4d06bc314205bb3b6bdb612dde7f1" ], "groupID": "1", "id": "1", "location": "example.py:42", "message": "", "title": "This is an example Python exception", "metadata": { "title": "This is an example Python exception" }, "occurrence": { "evidenceData": {}, "evidenceDisplay": [], "fingerprint": "c4a4d06bc314205bb3b6bdb612dde7f1", "id": "1", "issueTitle": "This is an example Python exception", "subtitle": "example.py:42", "resourceId": "example.py:42", "detectionTime": "2018-11-06T21:19:55Z", "eventId": "9fac2ceed9344f2bbfdd1fdacb0ed9b1" }, "packages": { "my.package": "1.0.0" }, "platform": "python", "projectID": "1", "sdk": {}, "size": 7055, "tags": [ { "key": "browser", "value": "Chrome 28.0" }, { "key": "device", "value": "Other" }, { "key": "level", "value": "error" }, { "key": "os", "value": "Windows 8" }, { "key": "release", "value": "17642328ead24b51867165985996d04b29310337" }, { "key": "url", "value": "http://example.com/foo" }, { "key": "user", "value": "id:1" } ], "type": "default", "user": { "data": {}, "email": "sentry@example.com", "id": "1", "ip_address": "127.0.0.1", "name": "Sentry", "username": "sentry" } }, "eventId": "1", "groupId": "1", "organizationSlug": "the-interstellar-jurisdiction", "projectSlug": "pump-station" }, "summary": "Event example" } } } }, "description": "" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/events/": { "get": { "operationId": "Query Explore Events in Table Format", "description": "Retrieves explore data for a given organization.\n\n**Note**: This endpoint is intended to get a table of results, and is not for doing a full export of data sent to\nSentry.\n\nThe `field` query parameter determines what fields will be selected in the `data` and `meta` keys of the endpoint response.\n- The `data` key contains a list of results row by row that match the `query` made\n- The `meta` key contains information about the response, including the unit or type of the fields requested", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "field", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The fields, functions, or equations to request for the query. At most 20 fields can be selected per request. Each field can be one of the following types:\n- A built-in key field. See possible fields in the [properties table](/concepts/search/searchable-properties/), under any field that matches the dataset passed to the dataset parameter\n - example: `field=transaction`\n- A tag. Tags should use the `tag[{name}, {type}]` formatting to avoid ambiguity with any fields,\n - example: `field=tag[isEnterprise, string]`\n - example: `field=tag[numberOfBytes, number]`\n- A function which will be in the format of `function_name(parameters,...)`. See possible functions in the [query builder documentation](/product/discover-queries/query-builder/#stacking-functions).\n - when a function is included, Discover will group by any tags or fields\n - example: `field=count_if(transaction.duration,greater,300)`\n- An equation when prefixed with `equation|`. Read more about [equations here](/product/discover-queries/query-builder/query-equations/).\n - example: `field=equation|count_if(transaction.duration,greater,300) / count() * 100`\n", "required": true }, { "in": "query", "name": "dataset", "schema": { "type": "string", "enum": [ "errors", "logs", "profile_functions", "spans", "tracemetrics", "uptime_results" ] }, "description": "Which dataset to query. The chosen dataset determines which fields are queryable.\n- `errors` - Error events.\n- `logs` - Structured log events.\n- `profile_functions` - Function-level Profiling data.\n- `spans` - Distributed tracing span events.\n- `tracemetrics` - Application Metrics.\n- `uptime_results` - Uptime monitoring check results.\n", "required": true }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string" }, "description": "The period of time for the query, will override the start & end parameters, a number followed by one of:\n- `d` for days\n- `h` for hours\n- `m` for minutes\n- `s` for seconds\n- `w` for weeks\n\nFor example, `24h`, to mean query data starting from 24 hours ago to now." }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Filters results by using [query syntax](/product/sentry-basics/search/).\n\nExample: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`\n" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "What to order the results of the query by. Must be something in the `field` list, excluding equations." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Explore" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "type": "string" } }, "datasetReason": { "type": "string" }, "isMetricsData": { "type": "boolean" }, "isMetricsExtractedData": { "type": "boolean" } }, "required": [ "fields" ] } }, "required": [ "data", "meta" ] }, "examples": { "QueryEvents": { "value": { "data": [ { "count_if(transaction.duration,greater,300)": 5, "count()": 10, "equation|count_if(transaction.duration,greater,300) / count() * 100": 50, "transaction": "foo" }, { "count_if(transaction.duration,greater,300)": 3, "count()": 20, "equation|count_if(transaction.duration,greater,300) / count() * 100": 15, "transaction": "bar" }, { "count_if(transaction.duration,greater,300)": 8, "count()": 40, "equation|count_if(transaction.duration,greater,300) / count() * 100": 20, "transaction": "baz" } ], "meta": { "fields": { "count_if(transaction.duration,greater,300)": "integer", "count()": "integer", "equation|count_if(transaction.duration,greater,300) / count() * 100": "number", "transaction": "string" } } }, "summary": "Query Events" } } } }, "description": "" }, "400": { "description": "Invalid Query" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/events-timeseries/": { "get": { "operationId": "Query Explore Events in Timeseries Format", "description": "Retrieves explore data for a given organization as a timeseries.\n\nThis endpoint can return timeseries for either 1 or many axis, and results grouped to the top events depending\non the parameters passed", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "dataset", "schema": { "type": "string", "enum": [ "errors", "logs", "profile_functions", "spans", "tracemetrics", "uptime_results" ] }, "description": "Which dataset to query. The chosen dataset determines which fields are queryable.\n- `errors` - Error events.\n- `logs` - Structured log events.\n- `profile_functions` - Function-level Profiling data.\n- `spans` - Distributed tracing span events.\n- `tracemetrics` - Application Metrics.\n- `uptime_results` - Uptime monitoring check results.\n", "required": true }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string" }, "description": "The period of time for the query, will override the start & end parameters, a number followed by one of:\n- `d` for days\n- `h` for hours\n- `m` for minutes\n- `s` for seconds\n- `w` for weeks\n\nFor example, `24h`, to mean query data starting from 24 hours ago to now." }, { "in": "query", "name": "topEvents", "schema": { "type": "integer" }, "description": "The number of top event results to return, must be between 1 and 10.\nWhen TopEvents is passed, both sort and groupBy are required parameters" }, { "in": "query", "name": "comparisonDelta", "schema": { "type": "integer" }, "description": "The delta in seconds to return additional offset timeseries by" }, { "in": "query", "name": "interval", "schema": { "type": "integer" }, "description": "The size of the bucket for the timeseries to have, must be a value smaller than the window being\nqueried. If the interval is invalid a default interval will be selected instead" }, { "in": "query", "name": "sort", "schema": { "type": "string" }, "description": "What to order the results of the query by. Must be something in the `field` list, excluding equations." }, { "in": "query", "name": "groupBy", "schema": { "type": "array", "items": { "type": "string" } }, "description": "List of fields to group by, *Required* for topEvents queries as this and sort determine what the\ntop events are" }, { "in": "query", "name": "yAxis", "schema": { "type": "string" }, "description": "The aggregate field to create the timeseries for, defaults to `count()` when not included" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Filters results by using [query syntax](/product/sentry-basics/search/).\n\nExample: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`\n" }, { "in": "query", "name": "disableAggregateExtrapolation", "schema": { "type": "string", "enum": [ "0", "1" ] }, "description": "Whether to disable the use of extrapolation and return the sampled values, due to sampling the\nnumber returned may be less than the actual values sent to Sentry" }, { "in": "query", "name": "preventMetricAggregates", "schema": { "type": "string", "enum": [ "0", "1" ] }, "description": "Whether to throw an error when aggregates are passed in the query or groupBy" }, { "in": "query", "name": "excludeOther", "schema": { "type": "string", "enum": [ "0", "1" ] }, "description": "Only applicable with TopEvents, whether to include the 'other' timeseries which represents all the\nevents that aren't in the top groups." } ], "tags": [ "Explore" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "dataset": { "type": "string" }, "start": { "type": "number", "format": "double" }, "end": { "type": "number", "format": "double" } }, "required": [ "dataset", "end", "start" ] }, "timeSeries": { "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "incomplete": { "type": "boolean" }, "comparisonValue": { "type": "number", "format": "double" }, "sampleCount": { "type": "number", "format": "double" }, "sampleRate": { "type": "number", "format": "double", "nullable": true }, "confidence": { "enum": [ "low", "high" ], "type": "string", "nullable": true }, "incompleteReason": { "type": "string" } }, "required": [ "incomplete", "timestamp", "value" ] } }, "yAxis": { "type": "string" }, "groupBy": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number", "format": "double" }, { "type": "object", "nullable": true } ] } }, "required": [ "key", "value" ] } }, "meta": { "type": "object", "properties": { "order": { "type": "integer" }, "isOther": { "type": "boolean" }, "valueUnit": { "type": "string", "nullable": true }, "dataScanned": { "enum": [ "partial", "full" ], "type": "string" }, "valueType": { "type": "string" }, "interval": { "type": "number", "format": "double" } }, "required": [ "interval", "valueType", "valueUnit" ] } }, "required": [ "meta", "values", "yAxis" ] } } }, "required": [ "timeSeries" ] }, "examples": { "QueryTopEventsAsATimeseries": { "value": { "timeSeries": [ { "values": [ { "timestamp": 1741368281123, "value": 5, "incomplete": false }, { "timestamp": 1741368281123, "value": 5, "incomplete": false } ], "yAxis": "count()", "groupBy": [ { "key": "transaction", "value": "foo" }, { "key": "project", "value": "bar" }, { "key": "tag[foo]", "value": "baz" } ], "meta": { "valueUnit": null, "valueType": "integer", "interval": 3600 } }, { "values": [ { "timestamp": 1741368281123, "value": 5, "incomplete": false }, { "timestamp": 1741368281123, "value": 5, "incomplete": false } ], "yAxis": "count()", "groupBy": [ { "key": "transaction", "value": "foo" }, { "key": "project", "value": "ball" }, { "key": "tag[foo]", "value": "baz" } ], "meta": { "valueUnit": null, "valueType": "integer", "interval": 3600 } } ], "meta": { "dataset": "spans", "start": 1741368281123, "end": 1741368281123 } }, "summary": "Query Top Events as a Timeseries" } } } }, "description": "" }, "400": { "description": "Invalid Query" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/external-users/": { "post": { "operationId": "Create an External User", "description": "Link a user from an external provider to a Sentry user.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Integrations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "user_id": { "type": "integer", "description": "The user ID in Sentry." }, "external_name": { "type": "string", "description": "The associated name for the provider." }, "provider": { "enum": [ "github", "github_enterprise", "jira_server", "slack", "slack_staging", "perforce", "gitlab", "msteams", "custom_scm" ], "type": "string", "description": "The provider of the external actor.\n\n* `github`\n* `github_enterprise`\n* `jira_server`\n* `slack`\n* `slack_staging`\n* `perforce`\n* `gitlab`\n* `msteams`\n* `custom_scm`" }, "integration_id": { "type": "integer", "description": "The Integration ID." }, "id": { "type": "integer", "readOnly": true, "description": "The external actor ID." }, "external_id": { "type": "string", "nullable": true, "description": "The associated user ID for provider." } }, "required": [ "external_name", "id", "integration_id", "provider", "user_id" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:admin", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] }, "examples": { "CreateAnExternalUser": { "value": { "externalName": "@Billybob", "provider": "github", "userId": "1", "integrationId": "1", "id": "1" }, "summary": "Create an external user" } } } }, "description": "" }, "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] }, "examples": { "CreateAnExternalUser": { "value": { "externalName": "@Billybob", "provider": "github", "userId": "1", "integrationId": "1", "id": "1" }, "summary": "Create an external user" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/external-users/{external_user_id}/": { "put": { "operationId": "Update an External User", "description": "Update a user in an external provider that is currently linked to a Sentry user.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "external_user_id", "schema": { "type": "integer" }, "description": "The ID of the external user object. This is returned when creating an external user.", "required": true } ], "tags": [ "Integrations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "user_id": { "type": "integer", "description": "The user ID in Sentry." }, "external_name": { "type": "string", "description": "The associated name for the provider." }, "provider": { "enum": [ "github", "github_enterprise", "jira_server", "slack", "slack_staging", "perforce", "gitlab", "msteams", "custom_scm" ], "type": "string", "description": "The provider of the external actor.\n\n* `github`\n* `github_enterprise`\n* `jira_server`\n* `slack`\n* `slack_staging`\n* `perforce`\n* `gitlab`\n* `msteams`\n* `custom_scm`" }, "integration_id": { "type": "integer", "description": "The Integration ID." }, "id": { "type": "integer", "readOnly": true, "description": "The external actor ID." }, "external_id": { "type": "string", "nullable": true, "description": "The associated user ID for provider." } }, "required": [ "external_name", "id", "integration_id", "provider", "user_id" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:admin", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] }, "examples": { "CreateAnExternalUser": { "value": { "externalName": "@Billybob", "provider": "github", "userId": "1", "integrationId": "1", "id": "1" }, "summary": "Create an external user" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } }, "delete": { "operationId": "Delete an External User", "description": "Delete the link between a user from an external provider and a Sentry user.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "external_user_id", "schema": { "type": "integer" }, "description": "The ID of the external user object. This is returned when creating an external user.", "required": true } ], "tags": [ "Integrations" ], "security": [ { "auth_token": [ "org:admin", "org:write" ] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/forwarding/": { "get": { "operationId": "Retrieve Data Forwarders for an Organization", "description": "Returns a list of data forwarders for an organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Integrations" ], "security": [ { "auth_token": [ "org:read" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "isEnabled": { "type": "boolean" }, "enrollNewProjects": { "type": "boolean" }, "enrolledProjects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] } }, "provider": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "projectConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isEnabled": { "type": "boolean" }, "dataForwarderId": { "type": "string" }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] }, "overrides": { "type": "object", "additionalProperties": { "type": "string" } }, "effectiveConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "dataForwarderId", "dateAdded", "dateUpdated", "effectiveConfig", "id", "isEnabled", "overrides", "project" ] } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "config", "dateAdded", "dateUpdated", "enrollNewProjects", "enrolledProjects", "id", "isEnabled", "organizationId", "projectConfigs", "provider" ] } }, "examples": { "ListAllDataForwardersForAnOrganization": { "value": [ { "id": "1", "organizationId": "1", "isEnabled": true, "enrollNewProjects": true, "enrolledProjects": [], "provider": "sqs", "config": { "region": "us-east-1", "queue_url": "https://sqs.us-east-1.amazonaws.com/01234567890/sentry-errors.fifo", "s3_bucket": "sentry-errors-bucket", "access_key": "AKIAIOSFODNN7EXAMPLE", "secret_key": "wJalrXUtnFEMI1K7MDENGSbPxRfiCYEXAMPLEKEY", "message_group_id": "sentry-errors" }, "projectConfigs": [], "dateAdded": "2025-11-01T00:00:00.000000Z", "dateUpdated": "2025-11-01T00:00:00.000000Z" }, { "id": "2", "organizationId": "1", "isEnabled": true, "enrollNewProjects": false, "enrolledProjects": [ { "id": "1", "slug": "proj-1", "platform": "javascript-react" }, { "id": "2", "slug": "proj-2", "platform": "python-flask" } ], "provider": "segment", "config": { "write_key": "itA5bLOPNxccvZ9ON1NYg9EXAMPLEKEY" }, "projectConfigs": [ { "id": "1", "isEnabled": true, "dataForwarderId": "2", "project": { "id": "1", "slug": "proj-1", "platform": "javascript-react" }, "overrides": {}, "effectiveConfig": { "write_key": "itA5bLOPNxccvZ9ON1NYg9EXAMPLEKEY" }, "dateAdded": "2025-11-01T00:00:00.000000Z", "dateUpdated": "2025-11-01T00:00:00.000000Z" }, { "id": "2", "isEnabled": true, "dataForwarderId": "2", "project": { "id": "2", "slug": "proj-2", "platform": "python-flask" }, "overrides": {}, "effectiveConfig": { "write_key": "itA5bLOPNxccvZ9ON1NYg9EXAMPLEKEY" }, "dateAdded": "2025-11-01T00:00:00.000000Z", "dateUpdated": "2025-11-01T00:00:00.000000Z" } ], "dateAdded": "2025-11-01T00:00:00.000000Z", "dateUpdated": "2025-11-01T00:00:00.000000Z" }, { "id": "3", "organizationId": "1", "isEnabled": true, "enrollNewProjects": true, "enrolledProjects": [ { "id": "1", "slug": "proj-1", "platform": "javascript-react" } ], "provider": "splunk", "config": { "index": "main", "token": "ab13cdef-45aa-1bcd-a123-bcEXAMPLEKEY", "source": "sentry", "instance_url": "https://prd-a-abcde.splunkcloud.com:8088" }, "projectConfigs": [ { "id": "3", "isEnabled": true, "dataForwarderId": "3", "project": { "id": "1", "slug": "proj-1", "platform": "javascript-react" }, "overrides": { "source": "sentry-custom" }, "effectiveConfig": { "index": "main", "token": "ab13cdef-45aa-1bcd-a123-bcEXAMPLEKEY", "source": "sentry-custom", "instance_url": "https://prd-a-abcde.splunkcloud.com:8088" }, "dateAdded": "2025-11-01T00:00:00.000000Z", "dateUpdated": "2025-11-01T00:00:00.000000Z" } ], "dateAdded": "2025-11-01T00:00:00.000000Z", "dateUpdated": "2025-11-01T00:00:00.000000Z" } ], "summary": "List all data forwarders for an organization" } } } }, "description": "" } } }, "post": { "operationId": "Create a Data Forwarder for an Organization", "description": "Creates a new data forwarder for an organization.\nOnly one data forwarder can be created per provider for a given organization.\n\nProject-specific overrides can only be created after creating the data forwarder.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Integrations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organization_id": { "type": "integer", "description": "The ID of the organization related to the data forwarder." }, "provider": { "enum": [ "segment", "sqs", "splunk" ], "type": "string", "description": "The provider of the data forwarder. One of \"segment\", \"sqs\", or \"splunk\".\n\n* `segment` - Segment\n* `sqs` - Amazon SQS\n* `splunk` - Splunk" }, "is_enabled": { "type": "boolean", "default": true, "description": "Whether the data forwarder is enabled." }, "enroll_new_projects": { "type": "boolean", "default": false, "description": "Whether to enroll new projects automatically, after they're created." }, "config": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The configuration for the data forwarder, specific to the provider type. \nFor a 'sqs' provider, the required keys are queue_url, region, access_key, secret_key. If using a FIFO queue, you must also provide a message_group_id, though s3_bucket is optional. \nFor a 'segment' provider, the required keys are write_key. \nFor a 'splunk' provider, the required keys are instance_url, index, source, token." }, "project_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the projects connected to the data forwarder. Missing project IDs will be unenrolled if previously enrolled." } }, "required": [ "organization_id", "provider" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "isEnabled": { "type": "boolean" }, "enrollNewProjects": { "type": "boolean" }, "enrolledProjects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] } }, "provider": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "projectConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isEnabled": { "type": "boolean" }, "dataForwarderId": { "type": "string" }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] }, "overrides": { "type": "object", "additionalProperties": { "type": "string" } }, "effectiveConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "dataForwarderId", "dateAdded", "dateUpdated", "effectiveConfig", "id", "isEnabled", "overrides", "project" ] } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "config", "dateAdded", "dateUpdated", "enrollNewProjects", "enrolledProjects", "id", "isEnabled", "organizationId", "projectConfigs", "provider" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/forwarding/{data_forwarder_id}/": { "put": { "operationId": "Update a Data Forwarder for an Organization", "description": "Updates a data forwarder for an organization or update a project-specific override.\nUpdates to the data forwarder's configuration require `org:write` permissions, and the entire\nconfiguration to be provided, including the `project_ids` field.\n\nTo configure project-specific overrides, specify only the following fields:\n\n - 'project_id': The ID of the project to create/modify the override for.\n - 'overrides': Follows the same format as `config` but all provider fields are optional, since only specified fields are overridden.\n - 'is_enabled': To enable/disable the forwarder for events on the specific project.\n\nOverrides can be performed with `project:write` permissions on the project being modified.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "data_forwarder_id", "schema": { "type": "integer" }, "description": "The ID of the data forwarder you'd like to query.", "required": true } ], "tags": [ "Integrations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organization_id": { "type": "integer", "description": "The ID of the organization related to the data forwarder." }, "provider": { "enum": [ "segment", "sqs", "splunk" ], "type": "string", "description": "The provider of the data forwarder. One of \"segment\", \"sqs\", or \"splunk\".\n\n* `segment` - Segment\n* `sqs` - Amazon SQS\n* `splunk` - Splunk" }, "is_enabled": { "type": "boolean", "default": true, "description": "Whether the data forwarder is enabled." }, "enroll_new_projects": { "type": "boolean", "default": false, "description": "Whether to enroll new projects automatically, after they're created." }, "config": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The configuration for the data forwarder, specific to the provider type. \nFor a 'sqs' provider, the required keys are queue_url, region, access_key, secret_key. If using a FIFO queue, you must also provide a message_group_id, though s3_bucket is optional. \nFor a 'segment' provider, the required keys are write_key. \nFor a 'splunk' provider, the required keys are instance_url, index, source, token." }, "project_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the projects connected to the data forwarder. Missing project IDs will be unenrolled if previously enrolled." } }, "required": [ "organization_id", "provider" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "isEnabled": { "type": "boolean" }, "enrollNewProjects": { "type": "boolean" }, "enrolledProjects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] } }, "provider": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "projectConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isEnabled": { "type": "boolean" }, "dataForwarderId": { "type": "string" }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] }, "overrides": { "type": "object", "additionalProperties": { "type": "string" } }, "effectiveConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "dataForwarderId", "dateAdded", "dateUpdated", "effectiveConfig", "id", "isEnabled", "overrides", "project" ] } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "config", "dateAdded", "dateUpdated", "enrollNewProjects", "enrolledProjects", "id", "isEnabled", "organizationId", "projectConfigs", "provider" ] }, "examples": { "ADataForwarderForAnOrganization": { "value": { "id": "1", "organizationId": "1", "isEnabled": true, "enrollNewProjects": true, "enrolledProjects": [], "provider": "sqs", "config": { "region": "us-east-1", "queue_url": "https://sqs.us-east-1.amazonaws.com/01234567890/sentry-errors.fifo", "s3_bucket": "sentry-errors-bucket", "access_key": "AKIAIOSFODNN7EXAMPLE", "secret_key": "wJalrXUtnFEMI1K7MDENGSbPxRfiCYEXAMPLEKEY", "message_group_id": "sentry-errors" }, "projectConfigs": [], "dateAdded": "2025-11-01T00:00:00.000000Z", "dateUpdated": "2025-11-01T00:00:00.000000Z" }, "summary": "A data forwarder for an organization" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } }, "delete": { "operationId": "Delete a Data Forwarder for an Organization", "description": "Deletes a data forwarder for an organization. All project-specific overrides will be deleted as well.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "data_forwarder_id", "schema": { "type": "integer" }, "description": "The ID of the data forwarder you'd like to query.", "required": true } ], "tags": [ "Integrations" ], "security": [ { "auth_token": [ "org:write" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/integrations/": { "get": { "operationId": "List an Organization's Available Integrations", "description": "Lists all the available Integrations for an Organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "providerKey", "schema": { "type": "string" }, "description": "Specific integration provider to filter by such as `slack`. See our [Integrations Documentation](/product/integrations/) for an updated list of providers." }, { "in": "query", "name": "features", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Integration features to filter by. See our [Integrations Documentation](/product/integrations/) for an updated list of features. Current available ones are:\n- `alert-rule`\n- `chat-unfurl`\n- `codeowners`\n- `commits`\n- `data-forwarding`\n- `deployment`\n- `enterprise-alert-rule`\n- `enterprise-incident-management`\n- `incident-management`\n- `issue-basic`\n- `issue-sync`\n- `mobile`\n- `serverless`\n- `session-replay`\n- `stacktrace-link`\n- `ticket-rules`\n " }, { "in": "query", "name": "includeConfig", "schema": { "type": "boolean" }, "description": "Specify `True` to fetch third-party integration configurations. Note that this can add several seconds to the response time." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Integrations" ], "security": [ { "auth_token": [ "org:admin", "org:integrations", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "domainName": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "type": "string" }, "provider": {}, "configOrganization": {}, "configData": {}, "externalId": { "type": "string" }, "organizationId": { "type": "integer" }, "organizationIntegrationStatus": { "type": "string" }, "gracePeriodEnd": { "type": "string", "nullable": true } }, "required": [ "accountType", "configData", "configOrganization", "domainName", "externalId", "gracePeriodEnd", "icon", "id", "name", "organizationId", "organizationIntegrationStatus", "provider", "scopes", "status" ] } }, "examples": { "ListAllAvailableIntegrationsForAlphabetSoupFactory": { "value": [ { "id": "24817", "name": "Alphabet Soup Factory", "icon": "https://avatars.slack-edge.com/alphabet-soup", "domainName": "alphabet-soup.slack.com", "accountType": null, "scopes": [ "channels:read", "chat:write", "chat:write.customize", "chat:write.public", "commands", "groups:read", "im:history", "im:read", "links:read", "links:write", "team:read", "users:read" ], "status": "active", "provider": { "key": "slack", "slug": "slack", "name": "Slack", "canAdd": true, "canDisable": false, "features": [ "alert-rule", "chat-unfurl" ], "aspects": { "alerts": [ { "type": "info", "text": "The Slack integration adds a new Alert Rule action to all projects. To enable automatic notifications sent to Slack you must create a rule using the slack workspace action in your project settings." } ] } }, "configOrganization": [], "configData": { "installationType": "born_as_bot" }, "externalId": "7252394", "organizationId": 6234528, "organizationIntegrationStatus": "active", "gracePeriodEnd": null } ], "summary": "List All Available Integrations for Alphabet Soup Factory" } } } }, "description": "" } } } }, "/api/0/organizations/{organization_id_or_slug}/integrations/{integration_id}/": { "get": { "operationId": "Retrieve an Integration for an Organization", "description": "OrganizationIntegrationBaseEndpoints expect both Integration and\nOrganizationIntegration DB entries to exist for a given organization and\nintegration_id.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "integration_id", "schema": { "type": "string" }, "description": "The ID of the integration installed on the organization.", "required": true } ], "tags": [ "Integrations" ], "security": [ { "auth_token": [ "org:admin", "org:integrations", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "domainName": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "type": "string" }, "provider": {}, "configOrganization": {}, "configData": {}, "externalId": { "type": "string" }, "organizationId": { "type": "integer" }, "organizationIntegrationStatus": { "type": "string" }, "gracePeriodEnd": { "type": "string", "nullable": true } }, "required": [ "accountType", "configData", "configOrganization", "domainName", "externalId", "gracePeriodEnd", "icon", "id", "name", "organizationId", "organizationIntegrationStatus", "provider", "scopes", "status" ] }, "examples": { "ListAllAvailableIntegrationsForAlphabetSoupFactory": { "value": { "id": "24817", "name": "Alphabet Soup Factory", "icon": "https://avatars.slack-edge.com/alphabet-soup", "domainName": "alphabet-soup.slack.com", "accountType": null, "scopes": [ "channels:read", "chat:write", "chat:write.customize", "chat:write.public", "commands", "groups:read", "im:history", "im:read", "links:read", "links:write", "team:read", "users:read" ], "status": "active", "provider": { "key": "slack", "slug": "slack", "name": "Slack", "canAdd": true, "canDisable": false, "features": [ "alert-rule", "chat-unfurl" ], "aspects": { "alerts": [ { "type": "info", "text": "The Slack integration adds a new Alert Rule action to all projects. To enable automatic notifications sent to Slack you must create a rule using the slack workspace action in your project settings." } ] } }, "configOrganization": [], "configData": { "installationType": "born_as_bot" }, "externalId": "7252394", "organizationId": 6234528, "organizationIntegrationStatus": "active", "gracePeriodEnd": null }, "summary": "List All Available Integrations for Alphabet Soup Factory" } } } }, "description": "" } } }, "delete": { "operationId": "Delete an Integration for an Organization", "description": "OrganizationIntegrationBaseEndpoints expect both Integration and\nOrganizationIntegration DB entries to exist for a given organization and\nintegration_id.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "integration_id", "schema": { "type": "string" }, "description": "The ID of the integration installed on the organization.", "required": true } ], "tags": [ "Integrations" ], "security": [ { "auth_token": [ "org:admin", "org:integrations" ] } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/issues/": { "get": { "operationId": "List an Organization's Issues", "description": "Return a list of issues for an organization. All parameters are supplied as query string parameters. A default query of `is:unresolved` is applied. To return all results, use an empty query value (i.e. ``?query=`). ", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string" }, "description": "The period of time for the query, will override the start & end parameters, a number followed by one of:\n- `d` for days\n- `h` for hours\n- `m` for minutes\n- `s` for seconds\n- `w` for weeks\n\nFor example, `24h`, to mean query data starting from 24 hours ago to now." }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "groupStatsPeriod", "schema": { "type": "string", "enum": [ "", "14d", "24h", "auto" ] }, "description": "The timeline on which stats for the groups should be presented." }, { "in": "query", "name": "shortIdLookup", "schema": { "type": "string", "enum": [ "0", "1" ] }, "description": "If this is set to `1` then the query will be parsed for issue short IDs. These may ignore other filters (e.g. projects), which is why it is an opt-in." }, { "in": "query", "name": "query", "schema": { "type": "string", "default": "is:unresolved" }, "description": "An optional search query for filtering issues. A default query will apply if no view/query is set. For all results use this parameter with an empty string." }, { "in": "query", "name": "viewId", "schema": { "type": "string" }, "description": "The ID of the view to use. If no query is present, the view's query and filters will be applied." }, { "in": "query", "name": "sort", "schema": { "type": "string", "enum": [ "date", "freq", "inbox", "new", "recommended", "trends", "user" ], "default": "date" }, "description": "The sort order of the view. Options include 'Last Seen' (`date`), 'First Seen' (`new`), 'Trends' (`trends`), 'Events' (`freq`), 'Users' (`user`), 'Date Added' (`inbox`), and 'Recommended' (`recommended`)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 100 }, "description": "The maximum number of issues to affect. The maximum is 100." }, { "in": "query", "name": "expand", "schema": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "integrationIssues", "latestEventHasAttachments", "owners", "pluginActions", "pluginIssues", "sentryAppIssues", "sessions" ] } }, "description": "Additional data to include in the response." }, { "in": "query", "name": "collapse", "schema": { "type": "array", "items": { "type": "string", "enum": [ "base", "filtered", "lifetime", "stats", "unhandled" ] } }, "description": "Fields to remove from the response to improve query performance." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Events" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "shareId": { "type": "string" }, "shortId": { "type": "string" }, "title": { "type": "string" }, "culprit": { "type": "string", "nullable": true }, "permalink": { "type": "string" }, "logger": { "type": "string", "nullable": true }, "level": { "type": "string" }, "status": { "type": "string" }, "statusDetails": { "type": "object", "properties": { "autoResolved": { "type": "boolean" }, "ignoreCount": { "type": "integer" }, "ignoreUntil": { "type": "string", "format": "date-time" }, "ignoreUserCount": { "type": "integer" }, "ignoreUserWindow": { "type": "integer" }, "ignoreWindow": { "type": "integer" }, "actor": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "inNextRelease": { "type": "boolean" }, "inRelease": { "type": "string" }, "inCommit": { "type": "string" }, "pendingEvents": { "type": "integer" }, "info": {} } }, "substatus": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" }, "platform": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "priorityLockedAt": { "type": "string", "format": "date-time", "nullable": true }, "seerFixabilityScore": { "type": "number", "format": "double", "nullable": true }, "seerAutofixLastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "seerExplorerAutofixLastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "name", "platform", "slug" ] }, "type": { "type": "string" }, "issueType": { "type": "string" }, "issueCategory": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} }, "numComments": { "type": "integer" }, "assignedTo": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] }, "isBookmarked": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "subscriptionDetails": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "reason": { "type": "string" } }, "nullable": true }, "hasSeen": { "type": "boolean" }, "annotations": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string" }, "url": { "type": "string" } }, "required": [ "displayName", "url" ] } }, "isUnhandled": { "type": "boolean" }, "count": { "type": "string" }, "userCount": { "type": "integer" }, "firstSeen": { "type": "string", "format": "date-time", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "stats": { "type": "object", "additionalProperties": {} }, "lifetime": { "type": "object", "additionalProperties": {} }, "filtered": { "type": "object", "properties": { "count": { "type": "string" }, "userCount": { "type": "integer" }, "firstSeen": { "type": "string", "format": "date-time", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "stats": { "type": "object", "additionalProperties": {} } }, "required": [ "count", "firstSeen", "lastSeen", "stats", "userCount" ], "nullable": true }, "sessionCount": { "type": "integer" }, "inbox": { "type": "object", "properties": { "reason": { "type": "integer" }, "reason_details": { "type": "object", "properties": { "until": { "type": "string", "nullable": true }, "count": { "type": "integer", "nullable": true }, "window": { "type": "integer", "nullable": true }, "user_count": { "type": "integer", "nullable": true }, "user_window": { "type": "integer", "nullable": true } }, "required": [ "count", "until", "user_count", "user_window", "window" ], "nullable": true }, "date_added": { "type": "string", "format": "date-time" } }, "required": [ "date_added", "reason", "reason_details" ] }, "owners": { "type": "object", "properties": { "type": { "type": "string" }, "owner": { "type": "string" }, "date_added": { "type": "string", "format": "date-time" } }, "required": [ "date_added", "owner", "type" ] }, "pluginActions": { "type": "array", "items": { "type": "array", "items": { "type": "string" }, "minLength": 2, "maxLength": 2 } }, "pluginIssues": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "integrationIssues": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "sentryAppIssues": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "latestEventHasAttachments": { "type": "boolean" } }, "required": [ "annotations", "assignedTo", "count", "culprit", "filtered", "firstSeen", "hasSeen", "id", "inbox", "integrationIssues", "isBookmarked", "isPublic", "isSubscribed", "isUnhandled", "issueCategory", "issueType", "lastSeen", "latestEventHasAttachments", "level", "lifetime", "logger", "metadata", "numComments", "owners", "permalink", "platform", "pluginActions", "pluginIssues", "priority", "priorityLockedAt", "project", "seerAutofixLastTriggered", "seerExplorerAutofixLastTriggered", "seerFixabilityScore", "sentryAppIssues", "sessionCount", "shareId", "shortId", "stats", "status", "statusDetails", "subscriptionDetails", "substatus", "title", "type", "userCount" ] } }, "examples": { "ReturnAListOfIssuesForAnOrganization": { "value": [ { "annotations": [], "assignedTo": { "type": "user", "id": "1", "name": "John Doe", "email": "john.doe@example.com" }, "count": "150", "culprit": "raven.scripts.runner in main", "firstSeen": "2018-11-06T21:19:55Z", "filtered": null, "inbox": { "reason": 0, "reason_details": null, "date_added": "2018-11-06T21:19:55Z" }, "hasSeen": false, "id": "1", "isBookmarked": false, "isPublic": false, "isSubscribed": true, "lastSeen": "2018-12-06T21:19:55Z", "level": "error", "logger": null, "metadata": { "title": "This is an example Python exception" }, "numComments": 0, "permalink": "https://sentry.io/the-interstellar-jurisdiction/pump-station/issues/1/", "project": { "id": "2", "name": "Pump Station", "slug": "pump-station", "platform": "python" }, "shareId": "123def456abc", "shortId": "PUMP-STATION-1", "stats": { "24h": [ [ 1541455200, 473 ], [ 1541458800, 914 ], [ 1541462400, 991 ], [ 1541466000, 925 ], [ 1541469600, 881 ], [ 1541473200, 182 ], [ 1541476800, 490 ], [ 1541480400, 820 ], [ 1541484000, 322 ], [ 1541487600, 836 ], [ 1541491200, 565 ], [ 1541494800, 758 ], [ 1541498400, 880 ], [ 1541502000, 677 ], [ 1541505600, 381 ], [ 1541509200, 814 ], [ 1541512800, 329 ], [ 1541516400, 446 ], [ 1541520000, 731 ], [ 1541523600, 111 ], [ 1541527200, 926 ], [ 1541530800, 772 ], [ 1541534400, 400 ], [ 1541538000, 943 ] ] }, "priority": "medium", "priorityLockedAt": null, "owners": { "type": "user", "owner": "1", "date_added": "2018-11-06T21:19:55Z" }, "platform": "python", "lifetime": { "count": "150", "userCount": 0, "firstSeen": "2018-11-06T21:19:55Z", "lastSeen": "2018-12-06T21:19:55Z" }, "seerAutofixLastTriggered": null, "seerExplorerAutofixLastTriggered": null, "seerFixabilityScore": null, "status": "ignored", "substatus": "archived_until_condition_met", "statusDetails": {}, "subscriptionDetails": null, "title": "This is an example Python exception", "type": "default", "userCount": 0, "integrationIssues": [], "pluginIssues": [], "pluginActions": [], "sentryAppIssues": [], "isUnhandled": false, "issueCategory": "performance", "issueType": "performance_n_plus_one_db_queries", "sessionCount": 0, "latestEventHasAttachments": false } ], "summary": "Return a list of issues for an organization" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Bulk Mutate an Organization's Issues", "description": "Bulk mutate various attributes on a maxmimum of 1000 issues. \n- For non-status updates, the `id` query parameter is required. \n- For status updates, the `id` query parameter may be omitted to update issues that match the filtering. \nIf any IDs are out of scope, the data won't be mutated but the endpoint will still produce a successful response. For example, if no issues were found matching the criteria, a HTTP 204 is returned.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "id", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The list of issue IDs to mutate. It is optional for status updates, in which an implicit `update all` is assumed." }, { "in": "query", "name": "query", "schema": { "type": "string", "default": "is:unresolved" }, "description": "An optional search query for filtering issues. A default query will apply if no view/query is set. For all results use this parameter with an empty string." }, { "in": "query", "name": "viewId", "schema": { "type": "string" }, "description": "The ID of the view to use. If no query is present, the view's query and filters will be applied." }, { "in": "query", "name": "sort", "schema": { "type": "string", "enum": [ "date", "freq", "inbox", "new", "recommended", "trends", "user" ], "default": "date" }, "description": "The sort order of the view. Options include 'Last Seen' (`date`), 'First Seen' (`new`), 'Trends' (`trends`), 'Events' (`freq`), 'Users' (`user`), 'Date Added' (`inbox`), and 'Recommended' (`recommended`)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 100 }, "description": "The maximum number of issues to affect. The maximum is 100." } ], "tags": [ "Events" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inbox": { "type": "boolean", "description": "If true, marks the issue as reviewed by the requestor." }, "status": { "enum": [ "resolved", "unresolved", "ignored", "resolvedInNextRelease", "muted" ], "type": "string", "description": "Limit mutations to only issues with the given status.\n\n* `resolved`\n* `unresolved`\n* `ignored`\n* `resolvedInNextRelease`\n* `muted`" }, "statusDetails": { "allOf": [ { "type": "object", "properties": { "inNextRelease": { "type": "boolean", "description": "If true, marks the issue as resolved in the next release." }, "inRelease": { "type": "string", "description": "The version of the release that the issue should be resolved in.If set to `latest`, the latest release will be used." }, "inCommit": { "allOf": [ { "type": "object", "properties": { "commit": { "type": "string", "description": "The SHA of the resolving commit." }, "repository": { "type": "string", "description": "The name of the repository (as it appears in Sentry)." } }, "required": [ "commit", "repository" ] } ], "description": "The commit data that the issue should use for resolution." }, "ignoreDuration": { "type": "integer", "description": "Ignore the issue until for this many minutes." }, "ignoreCount": { "type": "integer", "description": "Ignore the issue until it has occurred this many times in `ignoreWindow` minutes." }, "ignoreWindow": { "type": "integer", "maximum": 10080, "description": "Ignore the issue until it has occurred `ignoreCount` times in this many minutes. (Max: 1 week)" }, "ignoreUserCount": { "type": "integer", "description": "Ignore the issue until it has affected this many users in `ignoreUserWindow` minutes." }, "ignoreUserWindow": { "type": "integer", "maximum": 10080, "description": "Ignore the issue until it has affected `ignoreUserCount` users in this many minutes. (Max: 1 week)" } }, "required": [ "ignoreCount", "ignoreDuration", "ignoreUserCount", "ignoreUserWindow", "ignoreWindow", "inNextRelease", "inRelease" ] } ], "description": "Additional details about the resolution. Status detail updates that include release data are only allowed for issues within a single project." }, "substatus": { "enum": [ "archived_until_escalating", "archived_until_condition_met", "archived_forever", "escalating", "ongoing", "regressed", "new", null ], "type": "string", "nullable": true, "description": "The new substatus of the issue.\n\n* `archived_until_escalating`\n* `archived_until_condition_met`\n* `archived_forever`\n* `escalating`\n* `ongoing`\n* `regressed`\n* `new`" }, "hasSeen": { "type": "boolean", "description": "If true, marks the issue as seen by the requestor." }, "isBookmarked": { "type": "boolean", "description": "If true, bookmarks the issue for the requestor." }, "isPublic": { "type": "boolean", "description": "If true, publishes the issue." }, "isSubscribed": { "type": "boolean", "description": "If true, subscribes the requestor to the issue." }, "merge": { "type": "boolean", "description": "If true, merges the issues together." }, "discard": { "type": "boolean", "description": "If true, discards the issues instead of updating them." }, "assignedTo": { "type": "string", "description": "The user or team that should be assigned to the issues. Values take the form of ``, `user:`, ``, ``, or `team:`." }, "priority": { "enum": [ "low", "medium", "high" ], "type": "string", "description": "The priority that should be set for the issues\n\n* `low`\n* `medium`\n* `high`" } }, "required": [ "assignedTo", "discard", "hasSeen", "inbox", "isBookmarked", "isPublic", "isSubscribed", "merge", "priority", "status", "statusDetails", "substatus" ] } } }, "required": true }, "security": [ { "auth_token": [ "event:admin", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "assignedTo": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] }, "discard": { "type": "boolean" }, "hasSeen": { "type": "boolean" }, "inbox": { "type": "boolean" }, "isBookmarked": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "merge": { "type": "object", "properties": { "parent": { "type": "string" }, "children": { "type": "array", "items": { "type": "string" } } }, "required": [ "children", "parent" ] }, "priority": { "type": "string" }, "shareId": { "type": "string" }, "status": { "type": "string" }, "statusDetails": { "type": "object", "properties": { "inNextRelease": { "type": "boolean" }, "inRelease": { "type": "string" }, "inCommit": { "type": "object", "properties": { "commit": { "type": "string" }, "repository": { "type": "string" } }, "required": [ "commit", "repository" ] }, "ignoreDuration": { "type": "integer" }, "ignoreCount": { "type": "integer" }, "ignoreWindow": { "type": "integer" }, "ignoreUserCount": { "type": "integer" }, "ignoreUserWindow": { "type": "integer" } } }, "subscriptionDetails": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "reason": { "type": "string" } } }, "substatus": { "type": "string" } } }, "examples": { "ReturnTheUpdateResultsForIssuesInAnOrganization": { "value": { "assignedTo": { "type": "user", "id": "1", "name": "John Doe", "email": "john.doe@example.com" }, "discard": false, "hasSeen": true, "inbox": true, "isBookmarked": false, "isPublic": true, "isSubscribed": true, "merge": { "children": [ "11", "12", "13" ], "parent": "10" }, "priority": "medium", "shareId": "123def456abc", "status": "ignored", "statusDetails": { "ignoreDuration": 100, "ignoreCount": 10, "ignoreWindow": 60, "ignoreUserCount": 10, "ignoreUserWindow": 60, "inNextRelease": false, "inRelease": "1.0.0", "inCommit": { "commit": "123def456abc", "repository": "getsentry/sentry" } }, "subscriptionDetails": { "disabled": false, "reason": "mentioned" }, "substatus": "archived_until_condition_met" }, "summary": "Return the update results for issues in an organization" } } } }, "description": "" }, "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Bulk Remove an Organization's Issues", "description": "Permanently remove the given issues. If IDs are provided, queries and filtering will be ignored. If any IDs are out of scope, the data won't be mutated but the endpoint will still produce a successful response. For example, if no issues were found matching the criteria, a HTTP 204 is returned.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "id", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The list of issue IDs to be removed. If not provided, it will attempt to remove the first 1000 issues." }, { "in": "query", "name": "query", "schema": { "type": "string", "default": "is:unresolved" }, "description": "An optional search query for filtering issues. A default query will apply if no view/query is set. For all results use this parameter with an empty string." }, { "in": "query", "name": "viewId", "schema": { "type": "string" }, "description": "The ID of the view to use. If no query is present, the view's query and filters will be applied." }, { "in": "query", "name": "sort", "schema": { "type": "string", "enum": [ "date", "freq", "inbox", "new", "recommended", "trends", "user" ], "default": "date" }, "description": "The sort order of the view. Options include 'Last Seen' (`date`), 'First Seen' (`new`), 'Trends' (`trends`), 'Events' (`freq`), 'Users' (`user`), 'Date Added' (`inbox`), and 'Recommended' (`recommended`)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 100 }, "description": "The maximum number of issues to affect. The maximum is 100." } ], "tags": [ "Events" ], "security": [ { "auth_token": [ "event:admin" ] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/members/": { "get": { "operationId": "List an Organization's Members", "description": "List all organization members.\n\nResponse includes pending invites that are approved by organization owners or managers but waiting to be accepted by the invitee.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "member:admin", "member:read", "member:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "inviterName", "name", "orgRole", "pending" ] } }, "examples": { "ListOrganizationMembers": { "value": [ { "id": "57377908164", "email": "sirpenguin@antarcticarocks.com", "name": "Sir Penguin", "user": { "id": "280094367316", "name": "Sir Penguin", "username": "sirpenguin@antarcticarocks.com", "email": "sirpenguin@antarcticarocks.com", "avatarUrl": "https://secure.gravatar.com/avatar/16aeb26c5fdba335c7078e9e9ddb5149?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-07-06T21:13:58.375239Z", "lastLogin": "2021-08-02T18:25:00.051182Z", "has2fa": false, "lastActive": "2021-08-02T21:32:18.836829Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "2153450836", "email": "sirpenguin@antarcticarocks.com", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "canReset2fa": true }, "orgRole": "member", "pending": false, "expired": false, "flags": { "idp:provisioned": false, "idp:role-restricted": false, "sso:linked": false, "sso:invalid": false, "member-limit:restricted": false, "partnership:restricted": false }, "dateCreated": "2021-07-06T21:13:01.120263Z", "inviteStatus": "approved", "inviterName": "maininviter@antarcticarocks.com" }, { "id": "57377908165", "email": "rockhopper@antarcticarocks.com", "name": "Rockhopper", "orgRole": "member", "pending": true, "expired": false, "flags": { "idp:provisioned": false, "idp:role-restricted": false, "sso:linked": false, "sso:invalid": false, "member-limit:restricted": false, "partnership:restricted": false }, "dateCreated": "2021-07-07T21:13:01.120263Z", "inviteStatus": "pending", "inviterName": "maininviter@antarcticarocks.com" } ], "summary": "List organization members" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Add a Member to an Organization", "description": "Add or invite a member to an organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Organizations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "The email address to send the invitation to.", "maxLength": 75 }, "orgRole": { "enum": [ "billing", "member", "manager", "owner", "admin" ], "type": "string", "default": "member", "description": "The organization-level role of the new member. Roles include:\n\n* `billing` - Can manage payment and compliance details.\n* `member` - Can view and act on events, as well as view most other data within the organization.\n* `manager` - Has full management access to all teams and projects. Can also manage\n the organization's membership.\n* `owner` - Has unrestricted access to the organization, its data, and its\n settings. Can add, modify, and delete projects and members, as well as\n make billing and plan changes.\n* `admin` - Can edit global integrations, manage projects, and add/remove teams.\n They automatically assume the Team Admin role for teams they join.\n Note: This role can no longer be assigned in Business and Enterprise plans. Use `TeamRoles` instead.\n " }, "teamRoles": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true, "description": "The team and team-roles assigned to the member. Team roles can be either:\n - `contributor` - Can view and act on issues. Depending on organization settings, they can also add team members.\n - `admin` - Has full management access to their team's membership and projects." }, "sendInvite": { "type": "boolean", "writeOnly": true, "default": true, "description": "Whether or not to send an invite notification through email. Defaults to True." }, "reinvite": { "type": "boolean", "description": "Whether or not to re-invite a user who has already been invited to the organization. Defaults to True." } }, "required": [ "email" ] } } }, "required": true }, "security": [ { "auth_token": [ "member:admin", "member:invite", "member:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "inviterName", "name", "orgRole", "pending" ] }, "examples": { "AddAMemberToAnOrganization": { "value": { "id": "57377908164", "email": "sirpenguin@antarcticarocks.com", "name": "Sir Penguin", "user": { "id": "280094367316", "name": "Sir Penguin", "username": "sirpenguin@antarcticarocks.com", "email": "sirpenguin@antarcticarocks.com", "avatarUrl": "https://secure.gravatar.com/avatar/16aeb26c5fdba335c7078e9e9ddb5149?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-07-06T21:13:58.375239Z", "lastLogin": "2021-08-02T18:25:00.051182Z", "has2fa": false, "lastActive": "2021-08-02T21:32:18.836829Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "2153450836", "email": "sirpenguin@antarcticarocks.com", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "canReset2fa": true }, "orgRole": "member", "pending": false, "expired": false, "flags": { "idp:provisioned": false, "idp:role-restricted": false, "sso:linked": false, "sso:invalid": false, "member-limit:restricted": false, "partnership:restricted": false }, "dateCreated": "2021-07-06T21:13:01.120263Z", "inviteStatus": "approved", "inviterName": "maininviter@antarcticarocks.com" }, "summary": "Add a member to an organization" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/members/{member_id}/": { "get": { "operationId": "Retrieve an Organization Member", "description": "Retrieve an organization member's details.\n\nResponse will be a pending invite if it has been approved by organization owners or managers but is waiting to be accepted by the invitee.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the organization member.", "required": true } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "member:admin", "member:read", "member:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "role": { "type": "string" }, "roleName": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true }, "teams": { "type": "array", "items": { "type": "string" } }, "teamRoles": { "type": "array", "items": { "type": "object", "properties": { "teamSlug": { "type": "string" }, "role": { "type": "string", "nullable": true } }, "required": [ "role", "teamSlug" ] } }, "invite_link": { "type": "string", "nullable": true }, "isOnlyOwner": { "type": "boolean" }, "orgRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "is_global": { "type": "boolean" }, "isGlobal": { "type": "boolean" }, "minimumTeamRole": { "type": "string" } }, "required": [ "allowed", "desc", "id", "isAllowed", "isGlobal", "isRetired", "isTeamRolesAllowed", "is_global", "minimumTeamRole", "name", "scopes" ] } }, "teamRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "isMinimumRoleFor": { "type": "string", "nullable": true } }, "required": [ "allowed", "desc", "id", "isAllowed", "isMinimumRoleFor", "isRetired", "isTeamRolesAllowed", "name", "scopes" ] } } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "invite_link", "inviterName", "isOnlyOwner", "name", "orgRole", "orgRoleList", "pending", "teamRoleList", "teamRoles", "teams" ] }, "examples": { "UpdateOrganizationMember": { "value": { "id": "57377908164", "email": "sirpenguin@antarcticarocks.com", "name": "Sir Penguin", "user": { "id": "280094367316", "name": "Sir Penguin", "username": "sirpenguin@antarcticarocks.com", "email": "sirpenguin@antarcticarocks.com", "avatarUrl": "https://secure.gravatar.com/avatar/16aeb26c5fdba335c7078e9e9ddb5149?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-07-06T21:13:58.375239Z", "lastLogin": "2021-08-02T18:25:00.051182Z", "has2fa": false, "lastActive": "2021-08-02T21:32:18.836829Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "2153450836", "email": "sirpenguin@antarcticarocks.com", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "authenticators": [], "canReset2fa": true }, "role": "member", "orgRole": "member", "roleName": "Member", "pending": false, "expired": false, "flags": { "idp:provisioned": false, "idp:role-restricted": false, "sso:linked": false, "sso:invalid": false, "member-limit:restricted": false, "partnership:restricted": false }, "dateCreated": "2021-07-06T21:13:01.120263Z", "inviteStatus": "approved", "inviterName": "maininviter@antarcticarocks.com", "teams": [ "cool-team", "ancient-gabelers" ], "teamRoles": [ { "teamSlug": "ancient-gabelers", "role": "admin" }, { "teamSlug": "powerful-abolitionist", "role": "contributor" } ], "invite_link": null, "isOnlyOwner": false, "orgRoleList": [ { "id": "billing", "name": "Billing", "desc": "Can manage subscription and billing details.", "scopes": [ "org:billing" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": false, "minimumTeamRole": "contributor" }, { "id": "member", "name": "Member", "desc": "Members can view and act on events, as well as view most other data within the organization.", "scopes": [ "team:read", "project:releases", "org:read", "event:read", "alerts:write", "member:read", "alerts:read", "event:admin", "project:read", "event:write" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": true, "minimumTeamRole": "contributor" }, { "id": "admin", "name": "Admin", "desc": "Admin privileges on any teams of which they're a member. They can create new teams and projects, as well as remove teams and projects on which they already hold membership (or all teams, if open membership is enabled). Additionally, they can manage memberships of teams that they are members of. They cannot invite members to the organization.", "scopes": [ "team:admin", "org:integrations", "project:admin", "team:read", "project:releases", "org:read", "team:write", "event:read", "alerts:write", "member:read", "alerts:read", "event:admin", "project:read", "event:write", "project:write" ], "allowed": true, "isAllowed": true, "isRetired": true, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" }, { "id": "manager", "name": "Manager", "desc": "Gains admin access on all teams as well as the ability to add and remove members.", "scopes": [ "team:admin", "org:integrations", "project:releases", "team:write", "member:read", "org:write", "project:write", "project:admin", "team:read", "org:read", "event:read", "member:write", "alerts:write", "alerts:read", "event:admin", "project:read", "event:write", "member:admin" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": true, "isGlobal": true, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" }, { "id": "owner", "name": "Owner", "desc": "Unrestricted access to the organization, its data, and its settings. Can add, modify, and delete projects and members, as well as make billing and plan changes.", "scopes": [ "team:admin", "org:integrations", "project:releases", "org:admin", "team:write", "member:read", "org:write", "project:write", "project:admin", "team:read", "org:read", "event:read", "member:write", "alerts:write", "org:billing", "alerts:read", "event:admin", "project:read", "event:write", "member:admin" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": true, "isGlobal": true, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" } ], "teamRoleList": [ { "id": "contributor", "name": "Contributor", "desc": "Contributors can view and act on events, as well as view most other data within the team's projects.", "scopes": [ "project:read", "project:releases", "member:read", "team:read", "event:read", "alerts:read", "event:write", "org:read" ], "allowed": false, "isAllowed": false, "isRetired": false, "isTeamRolesAllowed": true, "isMinimumRoleFor": null }, { "id": "admin", "name": "Team Admin", "desc": "Admin privileges on the team. They can create and remove projects, and can manage the team's memberships.", "scopes": [ "project:read", "project:releases", "member:read", "event:admin", "team:write", "project:admin", "team:read", "org:integrations", "alerts:write", "team:admin", "project:write", "event:read", "alerts:read", "event:write", "org:read" ], "allowed": false, "isAllowed": false, "isRetired": false, "isTeamRolesAllowed": true, "isMinimumRoleFor": "admin" } ] }, "summary": "Update organization member" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update an Organization Member's Roles", "description": "Update a member's [organization-level](https://docs.sentry.io/organization/membership/#organization-level-roles) and [team-level](https://docs.sentry.io/organization/membership/#team-level-roles) roles.\n\nNote that for changing organization-roles, this endpoint is restricted to\n[user auth tokens](https://docs.sentry.io/account/auth-tokens/#user-auth-tokens).\nAdditionally, both the original and desired organization role must have\nthe same or lower permissions than the role of the organization user making the request\n\nFor example, an organization Manager may change someone's role from\nMember to Manager, but not to Owner.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the member to update.", "required": true } ], "tags": [ "Organizations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "orgRole": { "enum": [ "billing", "member", "manager", "owner", "admin" ], "type": "string", "description": "The organization role of the member. The options are:\n\n* `billing` - Can manage payment and compliance details.\n* `member` - Can view and act on events, as well as view most other data within the organization.\n* `manager` - Has full management access to all teams and projects. Can also manage\n the organization's membership.\n* `owner` - Has unrestricted access to the organization, its data, and its\n settings. Can add, modify, and delete projects and members, as well as\n make billing and plan changes.\n* `admin` - Can edit global integrations, manage projects, and add/remove teams.\n They automatically assume the Team Admin role for teams they join.\n Note: This role can no longer be assigned in Business and Enterprise plans. Use `TeamRoles` instead.\n " }, "teamRoles": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true, "description": "\nConfigures the team role of the member. The two roles are:\n- `contributor` - Can view and act on issues. Depending on organization settings, they can also add team members.\n- `admin` - Has full management access to their team's membership and projects.\n```json\n{\n \"teamRoles\": [\n {\n \"teamSlug\": \"ancient-gabelers\",\n \"role\": \"admin\"\n },\n {\n \"teamSlug\": \"powerful-abolitionist\",\n \"role\": \"contributor\"\n }\n ]\n}\n```\n" } } } } } }, "security": [ { "auth_token": [ "member:admin", "member:invite", "member:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "role": { "type": "string" }, "roleName": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true }, "teams": { "type": "array", "items": { "type": "string" } }, "teamRoles": { "type": "array", "items": { "type": "object", "properties": { "teamSlug": { "type": "string" }, "role": { "type": "string", "nullable": true } }, "required": [ "role", "teamSlug" ] } }, "invite_link": { "type": "string", "nullable": true }, "isOnlyOwner": { "type": "boolean" }, "orgRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "is_global": { "type": "boolean" }, "isGlobal": { "type": "boolean" }, "minimumTeamRole": { "type": "string" } }, "required": [ "allowed", "desc", "id", "isAllowed", "isGlobal", "isRetired", "isTeamRolesAllowed", "is_global", "minimumTeamRole", "name", "scopes" ] } }, "teamRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "isMinimumRoleFor": { "type": "string", "nullable": true } }, "required": [ "allowed", "desc", "id", "isAllowed", "isMinimumRoleFor", "isRetired", "isTeamRolesAllowed", "name", "scopes" ] } } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "invite_link", "inviterName", "isOnlyOwner", "name", "orgRole", "orgRoleList", "pending", "teamRoleList", "teamRoles", "teams" ] }, "examples": { "UpdateOrganizationMember": { "value": { "id": "57377908164", "email": "sirpenguin@antarcticarocks.com", "name": "Sir Penguin", "user": { "id": "280094367316", "name": "Sir Penguin", "username": "sirpenguin@antarcticarocks.com", "email": "sirpenguin@antarcticarocks.com", "avatarUrl": "https://secure.gravatar.com/avatar/16aeb26c5fdba335c7078e9e9ddb5149?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-07-06T21:13:58.375239Z", "lastLogin": "2021-08-02T18:25:00.051182Z", "has2fa": false, "lastActive": "2021-08-02T21:32:18.836829Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "2153450836", "email": "sirpenguin@antarcticarocks.com", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "authenticators": [], "canReset2fa": true }, "role": "member", "orgRole": "member", "roleName": "Member", "pending": false, "expired": false, "flags": { "idp:provisioned": false, "idp:role-restricted": false, "sso:linked": false, "sso:invalid": false, "member-limit:restricted": false, "partnership:restricted": false }, "dateCreated": "2021-07-06T21:13:01.120263Z", "inviteStatus": "approved", "inviterName": "maininviter@antarcticarocks.com", "teams": [ "cool-team", "ancient-gabelers" ], "teamRoles": [ { "teamSlug": "ancient-gabelers", "role": "admin" }, { "teamSlug": "powerful-abolitionist", "role": "contributor" } ], "invite_link": null, "isOnlyOwner": false, "orgRoleList": [ { "id": "billing", "name": "Billing", "desc": "Can manage subscription and billing details.", "scopes": [ "org:billing" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": false, "minimumTeamRole": "contributor" }, { "id": "member", "name": "Member", "desc": "Members can view and act on events, as well as view most other data within the organization.", "scopes": [ "team:read", "project:releases", "org:read", "event:read", "alerts:write", "member:read", "alerts:read", "event:admin", "project:read", "event:write" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": true, "minimumTeamRole": "contributor" }, { "id": "admin", "name": "Admin", "desc": "Admin privileges on any teams of which they're a member. They can create new teams and projects, as well as remove teams and projects on which they already hold membership (or all teams, if open membership is enabled). Additionally, they can manage memberships of teams that they are members of. They cannot invite members to the organization.", "scopes": [ "team:admin", "org:integrations", "project:admin", "team:read", "project:releases", "org:read", "team:write", "event:read", "alerts:write", "member:read", "alerts:read", "event:admin", "project:read", "event:write", "project:write" ], "allowed": true, "isAllowed": true, "isRetired": true, "is_global": false, "isGlobal": false, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" }, { "id": "manager", "name": "Manager", "desc": "Gains admin access on all teams as well as the ability to add and remove members.", "scopes": [ "team:admin", "org:integrations", "project:releases", "team:write", "member:read", "org:write", "project:write", "project:admin", "team:read", "org:read", "event:read", "member:write", "alerts:write", "alerts:read", "event:admin", "project:read", "event:write", "member:admin" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": true, "isGlobal": true, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" }, { "id": "owner", "name": "Owner", "desc": "Unrestricted access to the organization, its data, and its settings. Can add, modify, and delete projects and members, as well as make billing and plan changes.", "scopes": [ "team:admin", "org:integrations", "project:releases", "org:admin", "team:write", "member:read", "org:write", "project:write", "project:admin", "team:read", "org:read", "event:read", "member:write", "alerts:write", "org:billing", "alerts:read", "event:admin", "project:read", "event:write", "member:admin" ], "allowed": true, "isAllowed": true, "isRetired": false, "is_global": true, "isGlobal": true, "isTeamRolesAllowed": true, "minimumTeamRole": "admin" } ], "teamRoleList": [ { "id": "contributor", "name": "Contributor", "desc": "Contributors can view and act on events, as well as view most other data within the team's projects.", "scopes": [ "project:read", "project:releases", "member:read", "team:read", "event:read", "alerts:read", "event:write", "org:read" ], "allowed": false, "isAllowed": false, "isRetired": false, "isTeamRolesAllowed": true, "isMinimumRoleFor": null }, { "id": "admin", "name": "Team Admin", "desc": "Admin privileges on the team. They can create and remove projects, and can manage the team's memberships.", "scopes": [ "project:read", "project:releases", "member:read", "event:admin", "team:write", "project:admin", "team:read", "org:integrations", "alerts:write", "team:admin", "project:write", "event:read", "alerts:read", "event:write", "org:read" ], "allowed": false, "isAllowed": false, "isRetired": false, "isTeamRolesAllowed": true, "isMinimumRoleFor": "admin" } ] }, "summary": "Update organization member" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "operationId": "Delete an Organization Member", "description": "Remove an organization member.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the member to delete.", "required": true } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "member:admin", "member:read", "member:write" ] } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/members/{member_id}/teams/{team_id_or_slug}/": { "post": { "operationId": "Add an Organization Member to a Team", "description": "This request can return various success codes depending on the context of the team:\n- **`201`**: The member has been successfully added.\n- **`202`**: The member needs permission to join the team and an access request\nhas been generated.\n- **`204`**: The member is already on the team.\n\nIf the team is provisioned through an identity provider, the member cannot join the\nteam through Sentry.\n\nNote the permission scopes vary depending on the organization setting `\"Open Membership\"`\nand the type of authorization token. The following table outlines the accepted scopes.\n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
Open Membership
OnOff
Internal Integration Token\n
    \n
  • • org:read
    • \n
\n 		\n
    \n
  • • org:write
    • \n
  • • team:write
    • \n
\n
User Auth Token\n
    \n
  • • org:read
    • \n
\n 		\n
    \n
  • • org:read*
    • \n
  • • org:write
    • \n
  • • org:read +
    • \n
  •    team:write**
    • \n
\n
\n\n\n*Organization members are restricted to this scope. When sending a request, it will always\nreturn a 202 and request an invite to the team.\n\n\n\\*\\*Team Admins must have both **`org:read`** and **`team:write`** scopes in their user\nauthorization token to add members to their teams.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the organization member to add to the team", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "org:read", "org:write", "team:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] }, "examples": { "Join,RequestAccessToOrAddAMemberToATeam": { "value": { "id": "4502349234123", "slug": "ancient-gabelers", "name": "Ancient Gabelers", "dateCreated": "2023-05-31T19:47:53.621181Z", "isMember": true, "teamRole": "contributor", "flags": { "idp:provisioned": false }, "access": [ "alerts:read", "event:write", "project:read", "team:read", "member:read", "project:releases", "event:read", "org:read" ], "hasAccess": true, "isPending": false, "memberCount": 3, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null } }, "summary": "Join, request access to or add a member to a team" } } } }, "description": "" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "This team is managed through your organization's identity provider" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update an Organization Member's Team Role", "description": "The relevant organization member must already be a part of the team.\n\nNote that for organization admins, managers, and owners, they are\nautomatically granted a minimum team role of `admin` on all teams they\nare part of. Read more about [team roles](https://docs.sentry.io/product/teams/roles/).", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the organization member to change", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Teams" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "teamRole": { "enum": [ "contributor", "admin" ], "type": "string", "default": "contributor", "description": "The team-level role to switch to. Valid roles include:\n\n* `contributor` - Contributors can view and act on events, as well as view most other data within the team's projects.\n* `admin` - Admin privileges on the team. They can create and remove projects, and can manage the team's memberships." } } } } } }, "security": [ { "auth_token": [ "member:admin", "member:read", "member:write", "org:admin", "org:read", "org:write", "team:admin", "team:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "teamRole": { "enum": [ "contributor", "admin" ], "type": "string" } }, "required": [ "isActive", "teamRole" ] }, "examples": { "UpdateATeamRole": { "value": { "isActive": true, "teamRole": "admin" }, "summary": "Update a Team Role" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete an Organization Member from a Team", "description": "Delete an organization member from a team.\n\nNote the permission scopes vary depending on the type of authorization token. The following\ntable outlines the accepted scopes.\n\n \n \n \n \n \n \n \n \n
Org Auth Token\n
    \n
  • • org:write
    • \n
  • • org:admin
    • \n
  • • team:admin
    • \n
\n
User Auth Token\n
    \n
  • • org:read*
    • \n
  • • org:write
    • \n
  • • org:admin
    • \n
  • • team:admin
    • \n
  • • org:read + team:admin**
    • \n
\n
\n\n\n\\***`org:read`** can only be used to remove yourself from the teams you are a member of.\n\n\n\\*\\*Team Admins must have both **`org:read`** and **`team:admin`** scopes in their user\nauthorization token to delete members from their teams.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the organization member to delete from the team", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write", "team:admin" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] }, "examples": { "RemoveAMemberFromATeam": { "value": { "id": "4502349234123", "slug": "ancient-gabelers", "name": "Ancient Gabelers", "dateCreated": "2023-05-31T19:47:53.621181Z", "isMember": false, "teamRole": null, "flags": { "idp:provisioned": false }, "access": [ "alerts:read", "event:write", "project:read", "team:read", "member:read", "project:releases", "event:read", "org:read" ], "hasAccess": true, "isPending": false, "memberCount": 3, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null } }, "summary": "Remove a member from a team" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "This team is managed through your organization's identity provider" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/monitors/": { "get": { "operationId": "Retrieve Monitors for an Organization", "description": "Lists monitors, including nested monitor environments. May be filtered to a project or environment.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the monitor, in the format `user:id` or `team:id`. May be specified multiple times." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Crons" ], "security": [ { "auth_token": [ "alerts:read", "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "alertRule": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "targetIdentifier": { "type": "integer" }, "targetType": { "type": "string" } }, "required": [ "targetIdentifier", "targetType" ] } }, "environment": { "type": "string" } }, "required": [ "environment", "targets" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "isUpserting": { "type": "boolean" }, "config": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] }, "environments": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastCheckIn": { "type": "string", "format": "date-time" }, "nextCheckIn": { "type": "string", "format": "date-time" }, "nextCheckInLatest": { "type": "string", "format": "date-time" }, "activeIncident": { "type": "object", "properties": { "startingTimestamp": { "type": "string", "format": "date-time" }, "resolvingTimestamp": { "type": "string", "format": "date-time" }, "brokenNotice": { "type": "object", "properties": { "userNotifiedTimestamp": { "type": "string", "format": "date-time" }, "environmentMutedTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "environmentMutedTimestamp", "userNotifiedTimestamp" ], "nullable": true } }, "required": [ "brokenNotice", "resolvingTimestamp", "startingTimestamp" ], "nullable": true } }, "required": [ "activeIncident", "dateCreated", "isMuted", "lastCheckIn", "name", "nextCheckIn", "nextCheckInLatest", "status" ] }, "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] } }, "required": [ "config", "dateCreated", "environments", "id", "isMuted", "isUpserting", "name", "owner", "project", "slug", "status" ] } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Create a Monitor", "description": "Create a new monitor.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Crons" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "project": { "type": "string", "description": "The project slug to associate the monitor to." }, "name": { "type": "string", "description": "Name of the monitor. Used for notifications. If not set the slug will be derived from your monitor name.", "maxLength": 128 }, "config": { "allOf": [ { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string", "description": "Currently supports \"crontab\" or \"interval\"\n\n* `crontab`\n* `interval`" }, "schedule": { "description": "Varies depending on the schedule_type. Is either a crontab string, or a 2 element tuple for intervals (e.g. [1, 'day'])" }, "checkin_margin": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) after the expected checkin time will we wait until we consider the checkin to have been missed." }, "max_runtime": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) is the checkin allowed to run for in CheckInStatus.IN_PROGRESS before it is considered failed." }, "timezone": { "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "localtime", "" ], "type": "string", "description": "tz database style timezone string\n\n* `Africa/Abidjan`\n* `Africa/Accra`\n* `Africa/Addis_Ababa`\n* `Africa/Algiers`\n* `Africa/Asmara`\n* `Africa/Asmera`\n* `Africa/Bamako`\n* `Africa/Bangui`\n* `Africa/Banjul`\n* `Africa/Bissau`\n* `Africa/Blantyre`\n* `Africa/Brazzaville`\n* `Africa/Bujumbura`\n* `Africa/Cairo`\n* `Africa/Casablanca`\n* `Africa/Ceuta`\n* `Africa/Conakry`\n* `Africa/Dakar`\n* `Africa/Dar_es_Salaam`\n* `Africa/Djibouti`\n* `Africa/Douala`\n* `Africa/El_Aaiun`\n* `Africa/Freetown`\n* `Africa/Gaborone`\n* `Africa/Harare`\n* `Africa/Johannesburg`\n* `Africa/Juba`\n* `Africa/Kampala`\n* `Africa/Khartoum`\n* `Africa/Kigali`\n* `Africa/Kinshasa`\n* `Africa/Lagos`\n* `Africa/Libreville`\n* `Africa/Lome`\n* `Africa/Luanda`\n* `Africa/Lubumbashi`\n* `Africa/Lusaka`\n* `Africa/Malabo`\n* `Africa/Maputo`\n* `Africa/Maseru`\n* `Africa/Mbabane`\n* `Africa/Mogadishu`\n* `Africa/Monrovia`\n* `Africa/Nairobi`\n* `Africa/Ndjamena`\n* `Africa/Niamey`\n* `Africa/Nouakchott`\n* `Africa/Ouagadougou`\n* `Africa/Porto-Novo`\n* `Africa/Sao_Tome`\n* `Africa/Timbuktu`\n* `Africa/Tripoli`\n* `Africa/Tunis`\n* `Africa/Windhoek`\n* `America/Adak`\n* `America/Anchorage`\n* `America/Anguilla`\n* `America/Antigua`\n* `America/Araguaina`\n* `America/Argentina/Buenos_Aires`\n* `America/Argentina/Catamarca`\n* `America/Argentina/ComodRivadavia`\n* `America/Argentina/Cordoba`\n* `America/Argentina/Jujuy`\n* `America/Argentina/La_Rioja`\n* `America/Argentina/Mendoza`\n* `America/Argentina/Rio_Gallegos`\n* `America/Argentina/Salta`\n* `America/Argentina/San_Juan`\n* `America/Argentina/San_Luis`\n* `America/Argentina/Tucuman`\n* `America/Argentina/Ushuaia`\n* `America/Aruba`\n* `America/Asuncion`\n* `America/Atikokan`\n* `America/Atka`\n* `America/Bahia`\n* `America/Bahia_Banderas`\n* `America/Barbados`\n* `America/Belem`\n* `America/Belize`\n* `America/Blanc-Sablon`\n* `America/Boa_Vista`\n* `America/Bogota`\n* `America/Boise`\n* `America/Buenos_Aires`\n* `America/Cambridge_Bay`\n* `America/Campo_Grande`\n* `America/Cancun`\n* `America/Caracas`\n* `America/Catamarca`\n* `America/Cayenne`\n* `America/Cayman`\n* `America/Chicago`\n* `America/Chihuahua`\n* `America/Ciudad_Juarez`\n* `America/Coral_Harbour`\n* `America/Cordoba`\n* `America/Costa_Rica`\n* `America/Coyhaique`\n* `America/Creston`\n* `America/Cuiaba`\n* `America/Curacao`\n* `America/Danmarkshavn`\n* `America/Dawson`\n* `America/Dawson_Creek`\n* `America/Denver`\n* `America/Detroit`\n* `America/Dominica`\n* `America/Edmonton`\n* `America/Eirunepe`\n* `America/El_Salvador`\n* `America/Ensenada`\n* `America/Fort_Nelson`\n* `America/Fort_Wayne`\n* `America/Fortaleza`\n* `America/Glace_Bay`\n* `America/Godthab`\n* `America/Goose_Bay`\n* `America/Grand_Turk`\n* `America/Grenada`\n* `America/Guadeloupe`\n* `America/Guatemala`\n* `America/Guayaquil`\n* `America/Guyana`\n* `America/Halifax`\n* `America/Havana`\n* `America/Hermosillo`\n* `America/Indiana/Indianapolis`\n* `America/Indiana/Knox`\n* `America/Indiana/Marengo`\n* `America/Indiana/Petersburg`\n* `America/Indiana/Tell_City`\n* `America/Indiana/Vevay`\n* `America/Indiana/Vincennes`\n* `America/Indiana/Winamac`\n* `America/Indianapolis`\n* `America/Inuvik`\n* `America/Iqaluit`\n* `America/Jamaica`\n* `America/Jujuy`\n* `America/Juneau`\n* `America/Kentucky/Louisville`\n* `America/Kentucky/Monticello`\n* `America/Knox_IN`\n* `America/Kralendijk`\n* `America/La_Paz`\n* `America/Lima`\n* `America/Los_Angeles`\n* `America/Louisville`\n* `America/Lower_Princes`\n* `America/Maceio`\n* `America/Managua`\n* `America/Manaus`\n* `America/Marigot`\n* `America/Martinique`\n* `America/Matamoros`\n* `America/Mazatlan`\n* `America/Mendoza`\n* `America/Menominee`\n* `America/Merida`\n* `America/Metlakatla`\n* `America/Mexico_City`\n* `America/Miquelon`\n* `America/Moncton`\n* `America/Monterrey`\n* `America/Montevideo`\n* `America/Montreal`\n* `America/Montserrat`\n* `America/Nassau`\n* `America/New_York`\n* `America/Nipigon`\n* `America/Nome`\n* `America/Noronha`\n* `America/North_Dakota/Beulah`\n* `America/North_Dakota/Center`\n* `America/North_Dakota/New_Salem`\n* `America/Nuuk`\n* `America/Ojinaga`\n* `America/Panama`\n* `America/Pangnirtung`\n* `America/Paramaribo`\n* `America/Phoenix`\n* `America/Port-au-Prince`\n* `America/Port_of_Spain`\n* `America/Porto_Acre`\n* `America/Porto_Velho`\n* `America/Puerto_Rico`\n* `America/Punta_Arenas`\n* `America/Rainy_River`\n* `America/Rankin_Inlet`\n* `America/Recife`\n* `America/Regina`\n* `America/Resolute`\n* `America/Rio_Branco`\n* `America/Rosario`\n* `America/Santa_Isabel`\n* `America/Santarem`\n* `America/Santiago`\n* `America/Santo_Domingo`\n* `America/Sao_Paulo`\n* `America/Scoresbysund`\n* `America/Shiprock`\n* `America/Sitka`\n* `America/St_Barthelemy`\n* `America/St_Johns`\n* `America/St_Kitts`\n* `America/St_Lucia`\n* `America/St_Thomas`\n* `America/St_Vincent`\n* `America/Swift_Current`\n* `America/Tegucigalpa`\n* `America/Thule`\n* `America/Thunder_Bay`\n* `America/Tijuana`\n* `America/Toronto`\n* `America/Tortola`\n* `America/Vancouver`\n* `America/Virgin`\n* `America/Whitehorse`\n* `America/Winnipeg`\n* `America/Yakutat`\n* `America/Yellowknife`\n* `Antarctica/Casey`\n* `Antarctica/Davis`\n* `Antarctica/DumontDUrville`\n* `Antarctica/Macquarie`\n* `Antarctica/Mawson`\n* `Antarctica/McMurdo`\n* `Antarctica/Palmer`\n* `Antarctica/Rothera`\n* `Antarctica/South_Pole`\n* `Antarctica/Syowa`\n* `Antarctica/Troll`\n* `Antarctica/Vostok`\n* `Arctic/Longyearbyen`\n* `Asia/Aden`\n* `Asia/Almaty`\n* `Asia/Amman`\n* `Asia/Anadyr`\n* `Asia/Aqtau`\n* `Asia/Aqtobe`\n* `Asia/Ashgabat`\n* `Asia/Ashkhabad`\n* `Asia/Atyrau`\n* `Asia/Baghdad`\n* `Asia/Bahrain`\n* `Asia/Baku`\n* `Asia/Bangkok`\n* `Asia/Barnaul`\n* `Asia/Beirut`\n* `Asia/Bishkek`\n* `Asia/Brunei`\n* `Asia/Calcutta`\n* `Asia/Chita`\n* `Asia/Choibalsan`\n* `Asia/Chongqing`\n* `Asia/Chungking`\n* `Asia/Colombo`\n* `Asia/Dacca`\n* `Asia/Damascus`\n* `Asia/Dhaka`\n* `Asia/Dili`\n* `Asia/Dubai`\n* `Asia/Dushanbe`\n* `Asia/Famagusta`\n* `Asia/Gaza`\n* `Asia/Harbin`\n* `Asia/Hebron`\n* `Asia/Ho_Chi_Minh`\n* `Asia/Hong_Kong`\n* `Asia/Hovd`\n* `Asia/Irkutsk`\n* `Asia/Istanbul`\n* `Asia/Jakarta`\n* `Asia/Jayapura`\n* `Asia/Jerusalem`\n* `Asia/Kabul`\n* `Asia/Kamchatka`\n* `Asia/Karachi`\n* `Asia/Kashgar`\n* `Asia/Kathmandu`\n* `Asia/Katmandu`\n* `Asia/Khandyga`\n* `Asia/Kolkata`\n* `Asia/Krasnoyarsk`\n* `Asia/Kuala_Lumpur`\n* `Asia/Kuching`\n* `Asia/Kuwait`\n* `Asia/Macao`\n* `Asia/Macau`\n* `Asia/Magadan`\n* `Asia/Makassar`\n* `Asia/Manila`\n* `Asia/Muscat`\n* `Asia/Nicosia`\n* `Asia/Novokuznetsk`\n* `Asia/Novosibirsk`\n* `Asia/Omsk`\n* `Asia/Oral`\n* `Asia/Phnom_Penh`\n* `Asia/Pontianak`\n* `Asia/Pyongyang`\n* `Asia/Qatar`\n* `Asia/Qostanay`\n* `Asia/Qyzylorda`\n* `Asia/Rangoon`\n* `Asia/Riyadh`\n* `Asia/Saigon`\n* `Asia/Sakhalin`\n* `Asia/Samarkand`\n* `Asia/Seoul`\n* `Asia/Shanghai`\n* `Asia/Singapore`\n* `Asia/Srednekolymsk`\n* `Asia/Taipei`\n* `Asia/Tashkent`\n* `Asia/Tbilisi`\n* `Asia/Tehran`\n* `Asia/Tel_Aviv`\n* `Asia/Thimbu`\n* `Asia/Thimphu`\n* `Asia/Tokyo`\n* `Asia/Tomsk`\n* `Asia/Ujung_Pandang`\n* `Asia/Ulaanbaatar`\n* `Asia/Ulan_Bator`\n* `Asia/Urumqi`\n* `Asia/Ust-Nera`\n* `Asia/Vientiane`\n* `Asia/Vladivostok`\n* `Asia/Yakutsk`\n* `Asia/Yangon`\n* `Asia/Yekaterinburg`\n* `Asia/Yerevan`\n* `Atlantic/Azores`\n* `Atlantic/Bermuda`\n* `Atlantic/Canary`\n* `Atlantic/Cape_Verde`\n* `Atlantic/Faeroe`\n* `Atlantic/Faroe`\n* `Atlantic/Jan_Mayen`\n* `Atlantic/Madeira`\n* `Atlantic/Reykjavik`\n* `Atlantic/South_Georgia`\n* `Atlantic/St_Helena`\n* `Atlantic/Stanley`\n* `Australia/ACT`\n* `Australia/Adelaide`\n* `Australia/Brisbane`\n* `Australia/Broken_Hill`\n* `Australia/Canberra`\n* `Australia/Currie`\n* `Australia/Darwin`\n* `Australia/Eucla`\n* `Australia/Hobart`\n* `Australia/LHI`\n* `Australia/Lindeman`\n* `Australia/Lord_Howe`\n* `Australia/Melbourne`\n* `Australia/NSW`\n* `Australia/North`\n* `Australia/Perth`\n* `Australia/Queensland`\n* `Australia/South`\n* `Australia/Sydney`\n* `Australia/Tasmania`\n* `Australia/Victoria`\n* `Australia/West`\n* `Australia/Yancowinna`\n* `Brazil/Acre`\n* `Brazil/DeNoronha`\n* `Brazil/East`\n* `Brazil/West`\n* `CET`\n* `CST6CDT`\n* `Canada/Atlantic`\n* `Canada/Central`\n* `Canada/Eastern`\n* `Canada/Mountain`\n* `Canada/Newfoundland`\n* `Canada/Pacific`\n* `Canada/Saskatchewan`\n* `Canada/Yukon`\n* `Chile/Continental`\n* `Chile/EasterIsland`\n* `Cuba`\n* `EET`\n* `EST`\n* `EST5EDT`\n* `Egypt`\n* `Eire`\n* `Etc/GMT`\n* `Etc/GMT+0`\n* `Etc/GMT+1`\n* `Etc/GMT+10`\n* `Etc/GMT+11`\n* `Etc/GMT+12`\n* `Etc/GMT+2`\n* `Etc/GMT+3`\n* `Etc/GMT+4`\n* `Etc/GMT+5`\n* `Etc/GMT+6`\n* `Etc/GMT+7`\n* `Etc/GMT+8`\n* `Etc/GMT+9`\n* `Etc/GMT-0`\n* `Etc/GMT-1`\n* `Etc/GMT-10`\n* `Etc/GMT-11`\n* `Etc/GMT-12`\n* `Etc/GMT-13`\n* `Etc/GMT-14`\n* `Etc/GMT-2`\n* `Etc/GMT-3`\n* `Etc/GMT-4`\n* `Etc/GMT-5`\n* `Etc/GMT-6`\n* `Etc/GMT-7`\n* `Etc/GMT-8`\n* `Etc/GMT-9`\n* `Etc/GMT0`\n* `Etc/Greenwich`\n* `Etc/UCT`\n* `Etc/UTC`\n* `Etc/Universal`\n* `Etc/Zulu`\n* `Europe/Amsterdam`\n* `Europe/Andorra`\n* `Europe/Astrakhan`\n* `Europe/Athens`\n* `Europe/Belfast`\n* `Europe/Belgrade`\n* `Europe/Berlin`\n* `Europe/Bratislava`\n* `Europe/Brussels`\n* `Europe/Bucharest`\n* `Europe/Budapest`\n* `Europe/Busingen`\n* `Europe/Chisinau`\n* `Europe/Copenhagen`\n* `Europe/Dublin`\n* `Europe/Gibraltar`\n* `Europe/Guernsey`\n* `Europe/Helsinki`\n* `Europe/Isle_of_Man`\n* `Europe/Istanbul`\n* `Europe/Jersey`\n* `Europe/Kaliningrad`\n* `Europe/Kiev`\n* `Europe/Kirov`\n* `Europe/Kyiv`\n* `Europe/Lisbon`\n* `Europe/Ljubljana`\n* `Europe/London`\n* `Europe/Luxembourg`\n* `Europe/Madrid`\n* `Europe/Malta`\n* `Europe/Mariehamn`\n* `Europe/Minsk`\n* `Europe/Monaco`\n* `Europe/Moscow`\n* `Europe/Nicosia`\n* `Europe/Oslo`\n* `Europe/Paris`\n* `Europe/Podgorica`\n* `Europe/Prague`\n* `Europe/Riga`\n* `Europe/Rome`\n* `Europe/Samara`\n* `Europe/San_Marino`\n* `Europe/Sarajevo`\n* `Europe/Saratov`\n* `Europe/Simferopol`\n* `Europe/Skopje`\n* `Europe/Sofia`\n* `Europe/Stockholm`\n* `Europe/Tallinn`\n* `Europe/Tirane`\n* `Europe/Tiraspol`\n* `Europe/Ulyanovsk`\n* `Europe/Uzhgorod`\n* `Europe/Vaduz`\n* `Europe/Vatican`\n* `Europe/Vienna`\n* `Europe/Vilnius`\n* `Europe/Volgograd`\n* `Europe/Warsaw`\n* `Europe/Zagreb`\n* `Europe/Zaporozhye`\n* `Europe/Zurich`\n* `GB`\n* `GB-Eire`\n* `GMT`\n* `GMT+0`\n* `GMT-0`\n* `GMT0`\n* `Greenwich`\n* `HST`\n* `Hongkong`\n* `Iceland`\n* `Indian/Antananarivo`\n* `Indian/Chagos`\n* `Indian/Christmas`\n* `Indian/Cocos`\n* `Indian/Comoro`\n* `Indian/Kerguelen`\n* `Indian/Mahe`\n* `Indian/Maldives`\n* `Indian/Mauritius`\n* `Indian/Mayotte`\n* `Indian/Reunion`\n* `Iran`\n* `Israel`\n* `Jamaica`\n* `Japan`\n* `Kwajalein`\n* `Libya`\n* `MET`\n* `MST`\n* `MST7MDT`\n* `Mexico/BajaNorte`\n* `Mexico/BajaSur`\n* `Mexico/General`\n* `NZ`\n* `NZ-CHAT`\n* `Navajo`\n* `PRC`\n* `PST8PDT`\n* `Pacific/Apia`\n* `Pacific/Auckland`\n* `Pacific/Bougainville`\n* `Pacific/Chatham`\n* `Pacific/Chuuk`\n* `Pacific/Easter`\n* `Pacific/Efate`\n* `Pacific/Enderbury`\n* `Pacific/Fakaofo`\n* `Pacific/Fiji`\n* `Pacific/Funafuti`\n* `Pacific/Galapagos`\n* `Pacific/Gambier`\n* `Pacific/Guadalcanal`\n* `Pacific/Guam`\n* `Pacific/Honolulu`\n* `Pacific/Johnston`\n* `Pacific/Kanton`\n* `Pacific/Kiritimati`\n* `Pacific/Kosrae`\n* `Pacific/Kwajalein`\n* `Pacific/Majuro`\n* `Pacific/Marquesas`\n* `Pacific/Midway`\n* `Pacific/Nauru`\n* `Pacific/Niue`\n* `Pacific/Norfolk`\n* `Pacific/Noumea`\n* `Pacific/Pago_Pago`\n* `Pacific/Palau`\n* `Pacific/Pitcairn`\n* `Pacific/Pohnpei`\n* `Pacific/Ponape`\n* `Pacific/Port_Moresby`\n* `Pacific/Rarotonga`\n* `Pacific/Saipan`\n* `Pacific/Samoa`\n* `Pacific/Tahiti`\n* `Pacific/Tarawa`\n* `Pacific/Tongatapu`\n* `Pacific/Truk`\n* `Pacific/Wake`\n* `Pacific/Wallis`\n* `Pacific/Yap`\n* `Poland`\n* `Portugal`\n* `ROC`\n* `ROK`\n* `Singapore`\n* `Turkey`\n* `UCT`\n* `US/Alaska`\n* `US/Aleutian`\n* `US/Arizona`\n* `US/Central`\n* `US/East-Indiana`\n* `US/Eastern`\n* `US/Hawaii`\n* `US/Indiana-Starke`\n* `US/Michigan`\n* `US/Mountain`\n* `US/Pacific`\n* `US/Samoa`\n* `UTC`\n* `Universal`\n* `W-SU`\n* `WET`\n* `Zulu`\n* `localtime`" }, "failure_issue_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many consecutive missed or failed check-ins in a row before creating a new issue." }, "recovery_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many successful check-ins in a row before resolving an issue." } }, "required": [ "schedule" ] } ], "description": "The configuration for the monitor." }, "slug": { "type": "string", "description": "Uniquely identifies your monitor within your organization. Changing this slug will require updates to any instrumented check-in calls.", "maxLength": 50, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "status": { "enum": [ "active", "disabled" ], "type": "string", "default": "active", "description": "Status of the monitor. Disabled monitors will not accept events and will not count towards the monitor quota.\n\n* `active`\n* `disabled`" }, "owner": { "type": "string", "nullable": true, "description": "The ID of the team or user that owns the monitor. (eg. user:51 or team:6)" }, "is_muted": { "type": "boolean", "description": "Disable creation of monitor incidents" } }, "required": [ "config", "name", "project" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:read", "org:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "alertRule": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "targetIdentifier": { "type": "integer" }, "targetType": { "type": "string" } }, "required": [ "targetIdentifier", "targetType" ] } }, "environment": { "type": "string" } }, "required": [ "environment", "targets" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "isUpserting": { "type": "boolean" }, "config": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] }, "environments": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastCheckIn": { "type": "string", "format": "date-time" }, "nextCheckIn": { "type": "string", "format": "date-time" }, "nextCheckInLatest": { "type": "string", "format": "date-time" }, "activeIncident": { "type": "object", "properties": { "startingTimestamp": { "type": "string", "format": "date-time" }, "resolvingTimestamp": { "type": "string", "format": "date-time" }, "brokenNotice": { "type": "object", "properties": { "userNotifiedTimestamp": { "type": "string", "format": "date-time" }, "environmentMutedTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "environmentMutedTimestamp", "userNotifiedTimestamp" ], "nullable": true } }, "required": [ "brokenNotice", "resolvingTimestamp", "startingTimestamp" ], "nullable": true } }, "required": [ "activeIncident", "dateCreated", "isMuted", "lastCheckIn", "name", "nextCheckIn", "nextCheckInLatest", "status" ] }, "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] } }, "required": [ "config", "dateCreated", "environments", "id", "isMuted", "isUpserting", "name", "owner", "project", "slug", "status" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/monitors/{monitor_id_or_slug}/": { "get": { "operationId": "Retrieve a Monitor", "description": "Retrieves details for a monitor.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "monitor_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the monitor.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." } ], "tags": [ "Crons" ], "security": [ { "auth_token": [ "alerts:read", "alerts:write", "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "alertRule": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "targetIdentifier": { "type": "integer" }, "targetType": { "type": "string" } }, "required": [ "targetIdentifier", "targetType" ] } }, "environment": { "type": "string" } }, "required": [ "environment", "targets" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "isUpserting": { "type": "boolean" }, "config": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] }, "environments": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastCheckIn": { "type": "string", "format": "date-time" }, "nextCheckIn": { "type": "string", "format": "date-time" }, "nextCheckInLatest": { "type": "string", "format": "date-time" }, "activeIncident": { "type": "object", "properties": { "startingTimestamp": { "type": "string", "format": "date-time" }, "resolvingTimestamp": { "type": "string", "format": "date-time" }, "brokenNotice": { "type": "object", "properties": { "userNotifiedTimestamp": { "type": "string", "format": "date-time" }, "environmentMutedTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "environmentMutedTimestamp", "userNotifiedTimestamp" ], "nullable": true } }, "required": [ "brokenNotice", "resolvingTimestamp", "startingTimestamp" ], "nullable": true } }, "required": [ "activeIncident", "dateCreated", "isMuted", "lastCheckIn", "name", "nextCheckIn", "nextCheckInLatest", "status" ] }, "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] } }, "required": [ "config", "dateCreated", "environments", "id", "isMuted", "isUpserting", "name", "owner", "project", "slug", "status" ] } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update a Monitor", "description": "Update a monitor.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "monitor_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the monitor.", "required": true } ], "tags": [ "Crons" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "project": { "type": "string", "description": "The project slug to associate the monitor to." }, "name": { "type": "string", "description": "Name of the monitor. Used for notifications. If not set the slug will be derived from your monitor name.", "maxLength": 128 }, "config": { "allOf": [ { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string", "description": "Currently supports \"crontab\" or \"interval\"\n\n* `crontab`\n* `interval`" }, "schedule": { "description": "Varies depending on the schedule_type. Is either a crontab string, or a 2 element tuple for intervals (e.g. [1, 'day'])" }, "checkin_margin": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) after the expected checkin time will we wait until we consider the checkin to have been missed." }, "max_runtime": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) is the checkin allowed to run for in CheckInStatus.IN_PROGRESS before it is considered failed." }, "timezone": { "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "localtime", "" ], "type": "string", "description": "tz database style timezone string\n\n* `Africa/Abidjan`\n* `Africa/Accra`\n* `Africa/Addis_Ababa`\n* `Africa/Algiers`\n* `Africa/Asmara`\n* `Africa/Asmera`\n* `Africa/Bamako`\n* `Africa/Bangui`\n* `Africa/Banjul`\n* `Africa/Bissau`\n* `Africa/Blantyre`\n* `Africa/Brazzaville`\n* `Africa/Bujumbura`\n* `Africa/Cairo`\n* `Africa/Casablanca`\n* `Africa/Ceuta`\n* `Africa/Conakry`\n* `Africa/Dakar`\n* `Africa/Dar_es_Salaam`\n* `Africa/Djibouti`\n* `Africa/Douala`\n* `Africa/El_Aaiun`\n* `Africa/Freetown`\n* `Africa/Gaborone`\n* `Africa/Harare`\n* `Africa/Johannesburg`\n* `Africa/Juba`\n* `Africa/Kampala`\n* `Africa/Khartoum`\n* `Africa/Kigali`\n* `Africa/Kinshasa`\n* `Africa/Lagos`\n* `Africa/Libreville`\n* `Africa/Lome`\n* `Africa/Luanda`\n* `Africa/Lubumbashi`\n* `Africa/Lusaka`\n* `Africa/Malabo`\n* `Africa/Maputo`\n* `Africa/Maseru`\n* `Africa/Mbabane`\n* `Africa/Mogadishu`\n* `Africa/Monrovia`\n* `Africa/Nairobi`\n* `Africa/Ndjamena`\n* `Africa/Niamey`\n* `Africa/Nouakchott`\n* `Africa/Ouagadougou`\n* `Africa/Porto-Novo`\n* `Africa/Sao_Tome`\n* `Africa/Timbuktu`\n* `Africa/Tripoli`\n* `Africa/Tunis`\n* `Africa/Windhoek`\n* `America/Adak`\n* `America/Anchorage`\n* `America/Anguilla`\n* `America/Antigua`\n* `America/Araguaina`\n* `America/Argentina/Buenos_Aires`\n* `America/Argentina/Catamarca`\n* `America/Argentina/ComodRivadavia`\n* `America/Argentina/Cordoba`\n* `America/Argentina/Jujuy`\n* `America/Argentina/La_Rioja`\n* `America/Argentina/Mendoza`\n* `America/Argentina/Rio_Gallegos`\n* `America/Argentina/Salta`\n* `America/Argentina/San_Juan`\n* `America/Argentina/San_Luis`\n* `America/Argentina/Tucuman`\n* `America/Argentina/Ushuaia`\n* `America/Aruba`\n* `America/Asuncion`\n* `America/Atikokan`\n* `America/Atka`\n* `America/Bahia`\n* `America/Bahia_Banderas`\n* `America/Barbados`\n* `America/Belem`\n* `America/Belize`\n* `America/Blanc-Sablon`\n* `America/Boa_Vista`\n* `America/Bogota`\n* `America/Boise`\n* `America/Buenos_Aires`\n* `America/Cambridge_Bay`\n* `America/Campo_Grande`\n* `America/Cancun`\n* `America/Caracas`\n* `America/Catamarca`\n* `America/Cayenne`\n* `America/Cayman`\n* `America/Chicago`\n* `America/Chihuahua`\n* `America/Ciudad_Juarez`\n* `America/Coral_Harbour`\n* `America/Cordoba`\n* `America/Costa_Rica`\n* `America/Coyhaique`\n* `America/Creston`\n* `America/Cuiaba`\n* `America/Curacao`\n* `America/Danmarkshavn`\n* `America/Dawson`\n* `America/Dawson_Creek`\n* `America/Denver`\n* `America/Detroit`\n* `America/Dominica`\n* `America/Edmonton`\n* `America/Eirunepe`\n* `America/El_Salvador`\n* `America/Ensenada`\n* `America/Fort_Nelson`\n* `America/Fort_Wayne`\n* `America/Fortaleza`\n* `America/Glace_Bay`\n* `America/Godthab`\n* `America/Goose_Bay`\n* `America/Grand_Turk`\n* `America/Grenada`\n* `America/Guadeloupe`\n* `America/Guatemala`\n* `America/Guayaquil`\n* `America/Guyana`\n* `America/Halifax`\n* `America/Havana`\n* `America/Hermosillo`\n* `America/Indiana/Indianapolis`\n* `America/Indiana/Knox`\n* `America/Indiana/Marengo`\n* `America/Indiana/Petersburg`\n* `America/Indiana/Tell_City`\n* `America/Indiana/Vevay`\n* `America/Indiana/Vincennes`\n* `America/Indiana/Winamac`\n* `America/Indianapolis`\n* `America/Inuvik`\n* `America/Iqaluit`\n* `America/Jamaica`\n* `America/Jujuy`\n* `America/Juneau`\n* `America/Kentucky/Louisville`\n* `America/Kentucky/Monticello`\n* `America/Knox_IN`\n* `America/Kralendijk`\n* `America/La_Paz`\n* `America/Lima`\n* `America/Los_Angeles`\n* `America/Louisville`\n* `America/Lower_Princes`\n* `America/Maceio`\n* `America/Managua`\n* `America/Manaus`\n* `America/Marigot`\n* `America/Martinique`\n* `America/Matamoros`\n* `America/Mazatlan`\n* `America/Mendoza`\n* `America/Menominee`\n* `America/Merida`\n* `America/Metlakatla`\n* `America/Mexico_City`\n* `America/Miquelon`\n* `America/Moncton`\n* `America/Monterrey`\n* `America/Montevideo`\n* `America/Montreal`\n* `America/Montserrat`\n* `America/Nassau`\n* `America/New_York`\n* `America/Nipigon`\n* `America/Nome`\n* `America/Noronha`\n* `America/North_Dakota/Beulah`\n* `America/North_Dakota/Center`\n* `America/North_Dakota/New_Salem`\n* `America/Nuuk`\n* `America/Ojinaga`\n* `America/Panama`\n* `America/Pangnirtung`\n* `America/Paramaribo`\n* `America/Phoenix`\n* `America/Port-au-Prince`\n* `America/Port_of_Spain`\n* `America/Porto_Acre`\n* `America/Porto_Velho`\n* `America/Puerto_Rico`\n* `America/Punta_Arenas`\n* `America/Rainy_River`\n* `America/Rankin_Inlet`\n* `America/Recife`\n* `America/Regina`\n* `America/Resolute`\n* `America/Rio_Branco`\n* `America/Rosario`\n* `America/Santa_Isabel`\n* `America/Santarem`\n* `America/Santiago`\n* `America/Santo_Domingo`\n* `America/Sao_Paulo`\n* `America/Scoresbysund`\n* `America/Shiprock`\n* `America/Sitka`\n* `America/St_Barthelemy`\n* `America/St_Johns`\n* `America/St_Kitts`\n* `America/St_Lucia`\n* `America/St_Thomas`\n* `America/St_Vincent`\n* `America/Swift_Current`\n* `America/Tegucigalpa`\n* `America/Thule`\n* `America/Thunder_Bay`\n* `America/Tijuana`\n* `America/Toronto`\n* `America/Tortola`\n* `America/Vancouver`\n* `America/Virgin`\n* `America/Whitehorse`\n* `America/Winnipeg`\n* `America/Yakutat`\n* `America/Yellowknife`\n* `Antarctica/Casey`\n* `Antarctica/Davis`\n* `Antarctica/DumontDUrville`\n* `Antarctica/Macquarie`\n* `Antarctica/Mawson`\n* `Antarctica/McMurdo`\n* `Antarctica/Palmer`\n* `Antarctica/Rothera`\n* `Antarctica/South_Pole`\n* `Antarctica/Syowa`\n* `Antarctica/Troll`\n* `Antarctica/Vostok`\n* `Arctic/Longyearbyen`\n* `Asia/Aden`\n* `Asia/Almaty`\n* `Asia/Amman`\n* `Asia/Anadyr`\n* `Asia/Aqtau`\n* `Asia/Aqtobe`\n* `Asia/Ashgabat`\n* `Asia/Ashkhabad`\n* `Asia/Atyrau`\n* `Asia/Baghdad`\n* `Asia/Bahrain`\n* `Asia/Baku`\n* `Asia/Bangkok`\n* `Asia/Barnaul`\n* `Asia/Beirut`\n* `Asia/Bishkek`\n* `Asia/Brunei`\n* `Asia/Calcutta`\n* `Asia/Chita`\n* `Asia/Choibalsan`\n* `Asia/Chongqing`\n* `Asia/Chungking`\n* `Asia/Colombo`\n* `Asia/Dacca`\n* `Asia/Damascus`\n* `Asia/Dhaka`\n* `Asia/Dili`\n* `Asia/Dubai`\n* `Asia/Dushanbe`\n* `Asia/Famagusta`\n* `Asia/Gaza`\n* `Asia/Harbin`\n* `Asia/Hebron`\n* `Asia/Ho_Chi_Minh`\n* `Asia/Hong_Kong`\n* `Asia/Hovd`\n* `Asia/Irkutsk`\n* `Asia/Istanbul`\n* `Asia/Jakarta`\n* `Asia/Jayapura`\n* `Asia/Jerusalem`\n* `Asia/Kabul`\n* `Asia/Kamchatka`\n* `Asia/Karachi`\n* `Asia/Kashgar`\n* `Asia/Kathmandu`\n* `Asia/Katmandu`\n* `Asia/Khandyga`\n* `Asia/Kolkata`\n* `Asia/Krasnoyarsk`\n* `Asia/Kuala_Lumpur`\n* `Asia/Kuching`\n* `Asia/Kuwait`\n* `Asia/Macao`\n* `Asia/Macau`\n* `Asia/Magadan`\n* `Asia/Makassar`\n* `Asia/Manila`\n* `Asia/Muscat`\n* `Asia/Nicosia`\n* `Asia/Novokuznetsk`\n* `Asia/Novosibirsk`\n* `Asia/Omsk`\n* `Asia/Oral`\n* `Asia/Phnom_Penh`\n* `Asia/Pontianak`\n* `Asia/Pyongyang`\n* `Asia/Qatar`\n* `Asia/Qostanay`\n* `Asia/Qyzylorda`\n* `Asia/Rangoon`\n* `Asia/Riyadh`\n* `Asia/Saigon`\n* `Asia/Sakhalin`\n* `Asia/Samarkand`\n* `Asia/Seoul`\n* `Asia/Shanghai`\n* `Asia/Singapore`\n* `Asia/Srednekolymsk`\n* `Asia/Taipei`\n* `Asia/Tashkent`\n* `Asia/Tbilisi`\n* `Asia/Tehran`\n* `Asia/Tel_Aviv`\n* `Asia/Thimbu`\n* `Asia/Thimphu`\n* `Asia/Tokyo`\n* `Asia/Tomsk`\n* `Asia/Ujung_Pandang`\n* `Asia/Ulaanbaatar`\n* `Asia/Ulan_Bator`\n* `Asia/Urumqi`\n* `Asia/Ust-Nera`\n* `Asia/Vientiane`\n* `Asia/Vladivostok`\n* `Asia/Yakutsk`\n* `Asia/Yangon`\n* `Asia/Yekaterinburg`\n* `Asia/Yerevan`\n* `Atlantic/Azores`\n* `Atlantic/Bermuda`\n* `Atlantic/Canary`\n* `Atlantic/Cape_Verde`\n* `Atlantic/Faeroe`\n* `Atlantic/Faroe`\n* `Atlantic/Jan_Mayen`\n* `Atlantic/Madeira`\n* `Atlantic/Reykjavik`\n* `Atlantic/South_Georgia`\n* `Atlantic/St_Helena`\n* `Atlantic/Stanley`\n* `Australia/ACT`\n* `Australia/Adelaide`\n* `Australia/Brisbane`\n* `Australia/Broken_Hill`\n* `Australia/Canberra`\n* `Australia/Currie`\n* `Australia/Darwin`\n* `Australia/Eucla`\n* `Australia/Hobart`\n* `Australia/LHI`\n* `Australia/Lindeman`\n* `Australia/Lord_Howe`\n* `Australia/Melbourne`\n* `Australia/NSW`\n* `Australia/North`\n* `Australia/Perth`\n* `Australia/Queensland`\n* `Australia/South`\n* `Australia/Sydney`\n* `Australia/Tasmania`\n* `Australia/Victoria`\n* `Australia/West`\n* `Australia/Yancowinna`\n* `Brazil/Acre`\n* `Brazil/DeNoronha`\n* `Brazil/East`\n* `Brazil/West`\n* `CET`\n* `CST6CDT`\n* `Canada/Atlantic`\n* `Canada/Central`\n* `Canada/Eastern`\n* `Canada/Mountain`\n* `Canada/Newfoundland`\n* `Canada/Pacific`\n* `Canada/Saskatchewan`\n* `Canada/Yukon`\n* `Chile/Continental`\n* `Chile/EasterIsland`\n* `Cuba`\n* `EET`\n* `EST`\n* `EST5EDT`\n* `Egypt`\n* `Eire`\n* `Etc/GMT`\n* `Etc/GMT+0`\n* `Etc/GMT+1`\n* `Etc/GMT+10`\n* `Etc/GMT+11`\n* `Etc/GMT+12`\n* `Etc/GMT+2`\n* `Etc/GMT+3`\n* `Etc/GMT+4`\n* `Etc/GMT+5`\n* `Etc/GMT+6`\n* `Etc/GMT+7`\n* `Etc/GMT+8`\n* `Etc/GMT+9`\n* `Etc/GMT-0`\n* `Etc/GMT-1`\n* `Etc/GMT-10`\n* `Etc/GMT-11`\n* `Etc/GMT-12`\n* `Etc/GMT-13`\n* `Etc/GMT-14`\n* `Etc/GMT-2`\n* `Etc/GMT-3`\n* `Etc/GMT-4`\n* `Etc/GMT-5`\n* `Etc/GMT-6`\n* `Etc/GMT-7`\n* `Etc/GMT-8`\n* `Etc/GMT-9`\n* `Etc/GMT0`\n* `Etc/Greenwich`\n* `Etc/UCT`\n* `Etc/UTC`\n* `Etc/Universal`\n* `Etc/Zulu`\n* `Europe/Amsterdam`\n* `Europe/Andorra`\n* `Europe/Astrakhan`\n* `Europe/Athens`\n* `Europe/Belfast`\n* `Europe/Belgrade`\n* `Europe/Berlin`\n* `Europe/Bratislava`\n* `Europe/Brussels`\n* `Europe/Bucharest`\n* `Europe/Budapest`\n* `Europe/Busingen`\n* `Europe/Chisinau`\n* `Europe/Copenhagen`\n* `Europe/Dublin`\n* `Europe/Gibraltar`\n* `Europe/Guernsey`\n* `Europe/Helsinki`\n* `Europe/Isle_of_Man`\n* `Europe/Istanbul`\n* `Europe/Jersey`\n* `Europe/Kaliningrad`\n* `Europe/Kiev`\n* `Europe/Kirov`\n* `Europe/Kyiv`\n* `Europe/Lisbon`\n* `Europe/Ljubljana`\n* `Europe/London`\n* `Europe/Luxembourg`\n* `Europe/Madrid`\n* `Europe/Malta`\n* `Europe/Mariehamn`\n* `Europe/Minsk`\n* `Europe/Monaco`\n* `Europe/Moscow`\n* `Europe/Nicosia`\n* `Europe/Oslo`\n* `Europe/Paris`\n* `Europe/Podgorica`\n* `Europe/Prague`\n* `Europe/Riga`\n* `Europe/Rome`\n* `Europe/Samara`\n* `Europe/San_Marino`\n* `Europe/Sarajevo`\n* `Europe/Saratov`\n* `Europe/Simferopol`\n* `Europe/Skopje`\n* `Europe/Sofia`\n* `Europe/Stockholm`\n* `Europe/Tallinn`\n* `Europe/Tirane`\n* `Europe/Tiraspol`\n* `Europe/Ulyanovsk`\n* `Europe/Uzhgorod`\n* `Europe/Vaduz`\n* `Europe/Vatican`\n* `Europe/Vienna`\n* `Europe/Vilnius`\n* `Europe/Volgograd`\n* `Europe/Warsaw`\n* `Europe/Zagreb`\n* `Europe/Zaporozhye`\n* `Europe/Zurich`\n* `GB`\n* `GB-Eire`\n* `GMT`\n* `GMT+0`\n* `GMT-0`\n* `GMT0`\n* `Greenwich`\n* `HST`\n* `Hongkong`\n* `Iceland`\n* `Indian/Antananarivo`\n* `Indian/Chagos`\n* `Indian/Christmas`\n* `Indian/Cocos`\n* `Indian/Comoro`\n* `Indian/Kerguelen`\n* `Indian/Mahe`\n* `Indian/Maldives`\n* `Indian/Mauritius`\n* `Indian/Mayotte`\n* `Indian/Reunion`\n* `Iran`\n* `Israel`\n* `Jamaica`\n* `Japan`\n* `Kwajalein`\n* `Libya`\n* `MET`\n* `MST`\n* `MST7MDT`\n* `Mexico/BajaNorte`\n* `Mexico/BajaSur`\n* `Mexico/General`\n* `NZ`\n* `NZ-CHAT`\n* `Navajo`\n* `PRC`\n* `PST8PDT`\n* `Pacific/Apia`\n* `Pacific/Auckland`\n* `Pacific/Bougainville`\n* `Pacific/Chatham`\n* `Pacific/Chuuk`\n* `Pacific/Easter`\n* `Pacific/Efate`\n* `Pacific/Enderbury`\n* `Pacific/Fakaofo`\n* `Pacific/Fiji`\n* `Pacific/Funafuti`\n* `Pacific/Galapagos`\n* `Pacific/Gambier`\n* `Pacific/Guadalcanal`\n* `Pacific/Guam`\n* `Pacific/Honolulu`\n* `Pacific/Johnston`\n* `Pacific/Kanton`\n* `Pacific/Kiritimati`\n* `Pacific/Kosrae`\n* `Pacific/Kwajalein`\n* `Pacific/Majuro`\n* `Pacific/Marquesas`\n* `Pacific/Midway`\n* `Pacific/Nauru`\n* `Pacific/Niue`\n* `Pacific/Norfolk`\n* `Pacific/Noumea`\n* `Pacific/Pago_Pago`\n* `Pacific/Palau`\n* `Pacific/Pitcairn`\n* `Pacific/Pohnpei`\n* `Pacific/Ponape`\n* `Pacific/Port_Moresby`\n* `Pacific/Rarotonga`\n* `Pacific/Saipan`\n* `Pacific/Samoa`\n* `Pacific/Tahiti`\n* `Pacific/Tarawa`\n* `Pacific/Tongatapu`\n* `Pacific/Truk`\n* `Pacific/Wake`\n* `Pacific/Wallis`\n* `Pacific/Yap`\n* `Poland`\n* `Portugal`\n* `ROC`\n* `ROK`\n* `Singapore`\n* `Turkey`\n* `UCT`\n* `US/Alaska`\n* `US/Aleutian`\n* `US/Arizona`\n* `US/Central`\n* `US/East-Indiana`\n* `US/Eastern`\n* `US/Hawaii`\n* `US/Indiana-Starke`\n* `US/Michigan`\n* `US/Mountain`\n* `US/Pacific`\n* `US/Samoa`\n* `UTC`\n* `Universal`\n* `W-SU`\n* `WET`\n* `Zulu`\n* `localtime`" }, "failure_issue_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many consecutive missed or failed check-ins in a row before creating a new issue." }, "recovery_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many successful check-ins in a row before resolving an issue." } }, "required": [ "schedule" ] } ], "description": "The configuration for the monitor." }, "slug": { "type": "string", "description": "Uniquely identifies your monitor within your organization. Changing this slug will require updates to any instrumented check-in calls.", "maxLength": 50, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "status": { "enum": [ "active", "disabled" ], "type": "string", "default": "active", "description": "Status of the monitor. Disabled monitors will not accept events and will not count towards the monitor quota.\n\n* `active`\n* `disabled`" }, "owner": { "type": "string", "nullable": true, "description": "The ID of the team or user that owns the monitor. (eg. user:51 or team:6)" }, "is_muted": { "type": "boolean", "description": "Disable creation of monitor incidents" } }, "required": [ "config", "name", "project" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "project:admin", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "alertRule": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "targetIdentifier": { "type": "integer" }, "targetType": { "type": "string" } }, "required": [ "targetIdentifier", "targetType" ] } }, "environment": { "type": "string" } }, "required": [ "environment", "targets" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "isUpserting": { "type": "boolean" }, "config": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] }, "environments": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastCheckIn": { "type": "string", "format": "date-time" }, "nextCheckIn": { "type": "string", "format": "date-time" }, "nextCheckInLatest": { "type": "string", "format": "date-time" }, "activeIncident": { "type": "object", "properties": { "startingTimestamp": { "type": "string", "format": "date-time" }, "resolvingTimestamp": { "type": "string", "format": "date-time" }, "brokenNotice": { "type": "object", "properties": { "userNotifiedTimestamp": { "type": "string", "format": "date-time" }, "environmentMutedTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "environmentMutedTimestamp", "userNotifiedTimestamp" ], "nullable": true } }, "required": [ "brokenNotice", "resolvingTimestamp", "startingTimestamp" ], "nullable": true } }, "required": [ "activeIncident", "dateCreated", "isMuted", "lastCheckIn", "name", "nextCheckIn", "nextCheckInLatest", "status" ] }, "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] } }, "required": [ "config", "dateCreated", "environments", "id", "isMuted", "isUpserting", "name", "owner", "project", "slug", "status" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete a Monitor or Monitor Environments", "description": "Delete a monitor or monitor environments.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "monitor_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the monitor.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." } ], "tags": [ "Crons" ], "security": [ { "auth_token": [ "alerts:write", "project:admin", "project:write" ] } ], "responses": { "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/monitors/{monitor_id_or_slug}/checkins/": { "get": { "operationId": "Retrieve Check-Ins for a Monitor", "description": "Retrieve a list of check-ins for a monitor", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "monitor_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the monitor.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Crons" ], "security": [ { "auth_token": [ "alerts:read", "alerts:write", "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "duration": { "type": "integer", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dateInProgress": { "type": "string", "format": "date-time", "nullable": true }, "dateClock": { "type": "string", "format": "date-time" }, "expectedTime": { "type": "string", "format": "date-time" }, "monitorConfig": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] } }, "required": [ "dateAdded", "dateClock", "dateCreated", "dateInProgress", "dateUpdated", "duration", "environment", "expectedTime", "id", "monitorConfig", "status" ] } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/notifications/actions/": { "get": { "operationId": "List Spike Protection Notifications", "description": "Returns all Spike Protection Notification Actions for an organization.\n\nNotification Actions notify a set of members when an action has been triggered through a notification service such as Slack or Sentry.\nFor example, organization owners and managers can receive an email when a spike occurs.\n\nYou can use either the `project` or `projectSlug` query parameter to filter for certain projects. Note that if both are present, `projectSlug` takes priority.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "project_id_or_slug", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The project slugs to filter by. Use `$all` to include all available projects. For example, the following are valid parameters:\n- `/?projectSlug=$all`\n- `/?projectSlug=android&projectSlug=javascript-react`\n" }, { "in": "query", "name": "triggerType", "schema": { "type": "string" }, "description": "Type of the trigger that causes the notification. The only supported value right now is: `spike-protection`" } ], "tags": [ "Spike Protection" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewEmailSpikeProtectionNotificationActionForAProject": { "value": { "id": "836501735", "organizationId": "62848264", "serviceType": "sentry_notification", "targetDisplay": "default", "targetIdentifier": "default", "targetType": "specific", "triggerType": "spike-protection", "projects": [ 4505321021243392 ] }, "summary": "Create a new email spike protection notification action for a project" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } }, "post": { "operationId": "Create a Spike Protection Notification Action", "description": "Creates a new Notification Action for Spike Protection.\n\nNotification Actions notify a set of members when an action has been triggered through a notification service such as Slack or Sentry.\nFor example, organization owners and managers can receive an email when a spike occurs.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Spike Protection" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Django Rest Framework serializer for incoming NotificationAction API payloads", "properties": { "trigger_type": { "type": "string", "description": "Type of the trigger that causes the notification. The only supported trigger right now is: `spike-protection`." }, "service_type": { "type": "string", "description": "Service that is used for sending the notification.\n- `email`\n- `slack`\n- `sentry_notification`\n- `pagerduty`\n- `opsgenie`\n" }, "integration_id": { "type": "integer", "description": "ID of the integration used as the notification service. See\n[List Integrations](https://docs.sentry.io/api/integrations/list-an-organizations-available-integrations/)\nto retrieve a full list of integrations.\n\nRequired if **service_type** is `slack`, `pagerduty` or `opsgenie`.\n" }, "target_identifier": { "type": "string", "description": "ID of the notification target, like a Slack channel ID.\n\nRequired if **service_type** is `slack` or `opsgenie`.\n" }, "target_display": { "type": "string", "description": "Name of the notification target, like a Slack channel name.\n\nRequired if **service_type** is `slack` or `opsgenie`.\n" }, "projects": { "type": "array", "items": { "type": "string" }, "description": "List of projects slugs that the Notification Action is created for." } }, "required": [ "service_type", "trigger_type" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "CreateANewEmailSpikeProtectionNotificationActionForAProject": { "value": { "id": "836501735", "organizationId": "62848264", "serviceType": "sentry_notification", "targetDisplay": "default", "targetIdentifier": "default", "targetType": "specific", "triggerType": "spike-protection", "projects": [ 4505321021243392 ] }, "summary": "Create a new email spike protection notification action for a project" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/notifications/actions/{action_id}/": { "get": { "operationId": "Retrieve a Spike Protection Notification Action", "description": "Returns a serialized Spike Protection Notification Action object.\n\nNotification Actions notify a set of members when an action has been triggered through a notification service such as Slack or Sentry.\nFor example, organization owners and managers can receive an email when a spike occurs.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "action_id", "schema": { "type": "integer" }, "description": "ID of the notification action to retrieve", "required": true } ], "tags": [ "Spike Protection" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "RetrieveASpikeProtectionNotificationActionCreatedForAProject": { "value": { "id": "836501735", "organizationId": "62848264", "serviceType": "sentry_notification", "targetDisplay": "default", "targetIdentifier": "default", "targetType": "specific", "triggerType": "spike-protection", "projects": [ 4505321021243392 ] }, "summary": "Retrieve a spike protection notification action created for a project" } } } }, "description": "" } } }, "put": { "operationId": "Update a Spike Protection Notification Action", "description": "Updates a Spike Protection Notification Action.\n\nNotification Actions notify a set of members when an action has been triggered through a notification service such as Slack or Sentry.\nFor example, organization owners and managers can receive an email when a spike occurs.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "action_id", "schema": { "type": "integer" }, "description": "ID of the notification action to retrieve", "required": true } ], "tags": [ "Spike Protection" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Django Rest Framework serializer for incoming NotificationAction API payloads", "properties": { "trigger_type": { "type": "string", "description": "Type of the trigger that causes the notification. The only supported trigger right now is: `spike-protection`." }, "service_type": { "type": "string", "description": "Service that is used for sending the notification.\n- `email`\n- `slack`\n- `sentry_notification`\n- `pagerduty`\n- `opsgenie`\n" }, "integration_id": { "type": "integer", "description": "ID of the integration used as the notification service. See\n[List Integrations](https://docs.sentry.io/api/integrations/list-an-organizations-available-integrations/)\nto retrieve a full list of integrations.\n\nRequired if **service_type** is `slack`, `pagerduty` or `opsgenie`.\n" }, "target_identifier": { "type": "string", "description": "ID of the notification target, like a Slack channel ID.\n\nRequired if **service_type** is `slack` or `opsgenie`.\n" }, "target_display": { "type": "string", "description": "Name of the notification target, like a Slack channel name.\n\nRequired if **service_type** is `slack` or `opsgenie`.\n" }, "projects": { "type": "array", "items": { "type": "string" }, "description": "List of projects slugs that the Notification Action is created for." } }, "required": [ "service_type", "trigger_type" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "202": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "UpdateASpikeProtectionNotificationActionCreatedForAProjectToUseSentryNotificationAsNotificationService.": { "value": { "id": "836501735", "organizationId": "62848264", "serviceType": "sentry_notification", "targetDisplay": "default", "targetIdentifier": "default", "targetType": "specific", "triggerType": "spike-protection", "projects": [ 4505321021243392 ] }, "summary": "Update a spike protection notification action created for a project to use sentry_notification as notification service." } } } }, "description": "" }, "400": { "description": "Bad Request" } } }, "delete": { "operationId": "Delete a Spike Protection Notification Action", "description": "Deletes a Spike Protection Notification Action.\n\nNotification Actions notify a set of members when an action has been triggered through a notification service such as Slack or Sentry.\nFor example, organization owners and managers can receive an email when a spike occurs.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "action_id", "schema": { "type": "integer" }, "description": "ID of the notification action to retrieve", "required": true } ], "tags": [ "Spike Protection" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "204": { "description": "No Content" } } } }, "/api/0/organizations/{organization_id_or_slug}/preprodartifacts/{artifact_id}/install-details/": { "get": { "operationId": "Retrieve install info for a given artifact", "description": "Retrieve install info for a given artifact.\n\nReturns distribution and installation details for a specific preprod artifact,\nincluding whether the artifact is installable, the install URL, download count,\nand iOS-specific code signing information.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "artifact_id", "schema": { "type": "string" }, "description": "The ID of the build artifact.", "required": true } ], "tags": [ "Mobile Builds" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "buildId": { "type": "string" }, "state": { "type": "string" }, "appInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ] }, "gitInfo": { "type": "object", "properties": { "headSha": { "type": "string", "nullable": true }, "baseSha": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "headRepoName": { "type": "string", "nullable": true }, "baseRepoName": { "type": "string", "nullable": true }, "headRef": { "type": "string", "nullable": true }, "baseRef": { "type": "string", "nullable": true }, "prNumber": { "type": "integer", "nullable": true } }, "required": [ "baseRef", "baseRepoName", "baseSha", "headRef", "headRepoName", "headSha", "prNumber", "provider" ], "nullable": true }, "platform": { "type": "string", "nullable": true }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "buildConfiguration": { "type": "string", "nullable": true }, "isInstallable": { "type": "boolean" }, "installUrl": { "type": "string", "nullable": true }, "installUrlExpiresAt": { "type": "string", "nullable": true }, "downloadCount": { "type": "integer" }, "releaseNotes": { "type": "string", "nullable": true }, "installGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isCodeSignatureValid": { "type": "boolean", "nullable": true }, "profileName": { "type": "string", "nullable": true }, "codesigningType": { "type": "string", "nullable": true } }, "required": [ "appInfo", "buildConfiguration", "buildId", "codesigningType", "downloadCount", "gitInfo", "installGroups", "installUrl", "installUrlExpiresAt", "isCodeSignatureValid", "isInstallable", "platform", "profileName", "projectId", "projectSlug", "releaseNotes", "state" ] }, "examples": { "InstallableArtifact": { "value": { "buildId": "12345", "state": "PROCESSED", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "platform": "ANDROID", "projectId": "1", "projectSlug": "my-project", "buildConfiguration": "release", "isInstallable": true, "installUrl": "https://sentry.io/api/0/projects/org/project/files/installablepreprodartifact/abc123/?response_format=apk", "installUrlExpiresAt": "2025-01-15T22:30:00+00:00", "downloadCount": 5, "releaseNotes": "Bug fixes and performance improvements.", "installGroups": [ "beta-testers" ], "isCodeSignatureValid": null, "profileName": null, "codesigningType": null }, "summary": "Installable Artifact" }, "Non-InstallableArtifact": { "value": { "buildId": "12345", "state": "PROCESSED", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": null, "platform": "ANDROID", "projectId": "1", "projectSlug": "my-project", "buildConfiguration": null, "isInstallable": false, "installUrl": null, "installUrlExpiresAt": null, "downloadCount": 0, "releaseNotes": null, "installGroups": null, "isCodeSignatureValid": null, "profileName": null, "codesigningType": null }, "summary": "Non-Installable Artifact" }, "AppleArtifactWithCodeSigning": { "value": { "buildId": "12346", "state": "PROCESSED", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "XCARCHIVE", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "platform": "APPLE", "projectId": "1", "projectSlug": "my-project", "buildConfiguration": "release", "isInstallable": true, "installUrl": "https://sentry.io/api/0/projects/org/project/files/installablepreprodartifact/abc123/?response_format=plist", "installUrlExpiresAt": "2025-01-15T22:30:00+00:00", "downloadCount": 3, "releaseNotes": null, "installGroups": null, "isCodeSignatureValid": true, "profileName": "iOS Team Provisioning Profile", "codesigningType": "development" }, "summary": "Apple Artifact with Code Signing" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/preprodartifacts/{artifact_id}/size-analysis/": { "get": { "operationId": "Retrieve Size Analysis results for a given artifact", "description": "Retrieve size analysis results for a given artifact.\n\nReturns size metrics including download size, install size, and optional insights.\nWhen a base artifact exists (either from commit comparison or via the `baseArtifactId` parameter),\ncomparison data showing size differences is included.\n\nThe response `state` field indicates the analysis status:\n- `PENDING`: Analysis has not started yet.\n- `PROCESSING`: Analysis is currently running.\n- `FAILED` / `NOT_RAN`: Analysis did not complete; `errorCode` and `errorMessage` are included.\n- `COMPLETED`: Analysis finished successfully with full size data.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "artifact_id", "schema": { "type": "string" }, "description": "The ID of the build artifact.", "required": true }, { "in": "query", "name": "baseArtifactId", "schema": { "type": "string" }, "description": "Optional ID of the base artifact to compare against. If not provided, uses the default base head artifact." } ], "tags": [ "Mobile Builds" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "buildId": { "type": "string" }, "state": { "type": "string" }, "appInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ] }, "gitInfo": { "type": "object", "properties": { "headSha": { "type": "string", "nullable": true }, "baseSha": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "headRepoName": { "type": "string", "nullable": true }, "baseRepoName": { "type": "string", "nullable": true }, "headRef": { "type": "string", "nullable": true }, "baseRef": { "type": "string", "nullable": true }, "prNumber": { "type": "integer", "nullable": true } }, "required": [ "baseRef", "baseRepoName", "baseSha", "headRef", "headRepoName", "headSha", "prNumber", "provider" ], "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "downloadSize": { "type": "integer", "nullable": true }, "installSize": { "type": "integer", "nullable": true }, "analysisDuration": { "type": "number", "format": "double", "nullable": true }, "analysisVersion": { "type": "string", "nullable": true }, "baseBuildId": { "type": "string", "nullable": true }, "baseAppInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ], "nullable": true }, "insights": { "type": "object", "additionalProperties": {}, "nullable": true }, "appComponents": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "name": { "type": "string" }, "appId": { "type": "string" }, "path": { "type": "string" }, "downloadSize": { "type": "integer" }, "installSize": { "type": "integer" } }, "required": [ "appId", "componentType", "downloadSize", "installSize", "name", "path" ] }, "nullable": true }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "metricsArtifactType": { "type": "string" }, "identifier": { "type": "string", "nullable": true }, "state": { "type": "string" }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "sizeMetricDiff": { "type": "object", "properties": { "metricsArtifactType": { "type": "string" }, "identifier": { "type": "string", "nullable": true }, "headInstallSize": { "type": "integer" }, "headDownloadSize": { "type": "integer" }, "baseInstallSize": { "type": "integer" }, "baseDownloadSize": { "type": "integer" } }, "required": [ "baseDownloadSize", "baseInstallSize", "headDownloadSize", "headInstallSize", "identifier", "metricsArtifactType" ], "nullable": true }, "diffItems": { "type": "array", "items": { "type": "object", "properties": { "sizeDiff": { "type": "integer" }, "headSize": { "type": "integer", "nullable": true }, "baseSize": { "type": "integer", "nullable": true }, "path": { "type": "string" }, "itemType": { "type": "string", "nullable": true }, "type": { "type": "string" }, "diffItems": { "type": "array", "items": {}, "nullable": true } }, "required": [ "baseSize", "diffItems", "headSize", "itemType", "path", "sizeDiff", "type" ] }, "nullable": true }, "insightDiffItems": { "type": "array", "items": { "type": "object", "properties": { "insightType": { "type": "string" }, "status": { "type": "string" }, "totalSavingsChange": { "type": "integer" }, "fileDiffs": { "type": "array", "items": { "type": "object", "properties": { "sizeDiff": { "type": "integer" }, "headSize": { "type": "integer", "nullable": true }, "baseSize": { "type": "integer", "nullable": true }, "path": { "type": "string" }, "itemType": { "type": "string", "nullable": true }, "type": { "type": "string" }, "diffItems": { "type": "array", "items": {}, "nullable": true } }, "required": [ "baseSize", "diffItems", "headSize", "itemType", "path", "sizeDiff", "type" ] } }, "groupDiffs": { "type": "array", "items": { "type": "object", "properties": { "sizeDiff": { "type": "integer" }, "headSize": { "type": "integer", "nullable": true }, "baseSize": { "type": "integer", "nullable": true }, "path": { "type": "string" }, "itemType": { "type": "string", "nullable": true }, "type": { "type": "string" }, "diffItems": { "type": "array", "items": {}, "nullable": true } }, "required": [ "baseSize", "diffItems", "headSize", "itemType", "path", "sizeDiff", "type" ] } } }, "required": [ "fileDiffs", "groupDiffs", "insightType", "status", "totalSavingsChange" ] }, "nullable": true } }, "required": [ "diffItems", "errorCode", "errorMessage", "identifier", "insightDiffItems", "metricsArtifactType", "sizeMetricDiff", "state" ] }, "nullable": true } }, "required": [ "analysisDuration", "analysisVersion", "appComponents", "appInfo", "baseAppInfo", "baseBuildId", "buildId", "comparisons", "downloadSize", "errorCode", "errorMessage", "gitInfo", "insights", "installSize", "state" ] }, "examples": { "PendingAnalysis": { "value": { "buildId": "12345", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "errorCode": null, "errorMessage": null, "downloadSize": null, "installSize": null, "analysisDuration": null, "analysisVersion": null, "insights": null, "appComponents": null, "baseBuildId": null, "baseAppInfo": null, "comparisons": null, "state": "PENDING" }, "summary": "Pending Analysis" }, "FailedAnalysis": { "value": { "buildId": "12345", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "errorCode": "TIMEOUT", "errorMessage": "Failed to analyze artifact: unsupported format", "downloadSize": null, "installSize": null, "analysisDuration": null, "analysisVersion": null, "insights": null, "appComponents": null, "baseBuildId": null, "baseAppInfo": null, "comparisons": null, "state": "FAILED" }, "summary": "Failed Analysis" }, "CompletedAnalysis": { "value": { "buildId": "12345", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "errorCode": null, "errorMessage": null, "downloadSize": 5120000, "installSize": 10240000, "analysisDuration": 3.5, "analysisVersion": "1.0.0", "insights": null, "appComponents": null, "baseBuildId": null, "baseAppInfo": null, "comparisons": null, "state": "COMPLETED" }, "summary": "Completed Analysis" }, "CompletedAnalysisWithComparison": { "value": { "buildId": "12345", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "errorCode": null, "errorMessage": null, "downloadSize": 5120000, "installSize": 10240000, "analysisDuration": 3.5, "analysisVersion": "1.0.0", "insights": null, "appComponents": null, "baseBuildId": "12344", "baseAppInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.1.0", "buildNumber": 41, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "comparisons": [ { "metricsArtifactType": "MAIN_ARTIFACT", "identifier": null, "state": "SUCCESS", "errorCode": null, "errorMessage": null, "diffItems": [ { "sizeDiff": 1024, "headSize": 5120, "baseSize": 4096, "path": "lib/armeabi-v7a/libnative.so", "itemType": "native_library", "type": "modified", "diffItems": null } ], "insightDiffItems": null, "sizeMetricDiff": { "metricsArtifactType": "MAIN_ARTIFACT", "identifier": null, "headInstallSize": 10240000, "headDownloadSize": 5120000, "baseInstallSize": 9800000, "baseDownloadSize": 4900000 } } ], "state": "COMPLETED" }, "summary": "Completed Analysis with Comparison" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repositories/": { "get": { "operationId": "Retrieves list of repositories for a given owner", "description": "Retrieves repository data for a given owner.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "description": "The number of results to return. If not specified, defaults to 20." }, { "in": "query", "name": "navigation", "schema": { "type": "string" }, "description": "Whether to get the previous or next page from paginated results. Use `next` for forward pagination after the cursor or `prev` for backward pagination before the cursor. If not specified, defaults to `next`. If no cursor is provided, the cursor is the beginning of the result set." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The cursor pointing to a specific position in the result set to start the query from. Results after the cursor will be returned if used with `next` or before the cursor if used with `prev` for `navigation`." }, { "in": "query", "name": "term", "schema": { "type": "string" }, "description": "The term substring to filter name strings by using the `contains` operator." } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for repositories response", "properties": { "results": { "type": "array", "items": { "type": "object", "description": "Serializer for individual repository nodes from GraphQL response", "properties": { "name": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "latestCommitAt": { "type": "string", "format": "date-time" }, "defaultBranch": { "type": "string" } }, "required": [ "defaultBranch", "latestCommitAt", "name", "updatedAt" ] } }, "pageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "totalCount": { "type": "integer" } }, "required": [ "pageInfo", "results", "totalCount" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repositories/sync/": { "get": { "operationId": "Gets syncing status for repositories for an integrated org", "description": "Gets syncing status for repositories for an integrated organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for a sync repository response", "properties": { "isSyncing": { "type": "boolean" } }, "required": [ "isSyncing" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Syncs repositories from an integrated org with GitHub", "description": "Syncs repositories for an integrated organization with GitHub.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for a sync repository response", "properties": { "isSyncing": { "type": "boolean" } }, "required": [ "isSyncing" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repositories/tokens/": { "get": { "operationId": "Retrieves a paginated list of repository tokens for a given owner", "description": "Retrieves a paginated list of repository tokens for a given owner.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "description": "The number of results to return. If not specified, defaults to 20." }, { "in": "query", "name": "navigation", "schema": { "type": "string" }, "description": "Whether to get the previous or next page from paginated results. Use `next` for forward pagination after the cursor or `prev` for backward pagination before the cursor. If not specified, defaults to `next`. If no cursor is provided, the cursor is the beginning of the result set." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The cursor pointing to a specific position in the result set to start the query from. Results after the cursor will be returned if used with `next` or before the cursor if used with `prev` for `navigation`." }, { "in": "query", "name": "sortBy", "schema": { "type": "string" }, "description": "The property to sort results by. If not specified, the default is `COMMIT_DATE` in descending order. Use `-`\n for descending order.\n\nAvailable fields are:\n- `NAME`\n- `COMMIT_DATE`\n " } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for repository tokens response", "properties": { "results": { "type": "array", "items": { "type": "object", "description": "Serializer for individual repository nodes from GraphQL response", "properties": { "name": { "type": "string" }, "token": { "type": "string" } }, "required": [ "name", "token" ] } }, "pageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "totalCount": { "type": "integer" } }, "required": [ "pageInfo", "results", "totalCount" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repository/{repository}/": { "get": { "operationId": "Retrieves a single repository for a given owner", "description": "Retrieves repository data for a single repository.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true }, { "in": "path", "name": "repository", "schema": { "type": "string" }, "description": "The name of the repository.", "required": true } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for single repository response", "properties": { "uploadToken": { "type": "string", "nullable": true }, "testAnalyticsEnabled": { "type": "boolean" } }, "required": [ "testAnalyticsEnabled", "uploadToken" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repository/{repository}/branches/": { "get": { "operationId": "Retrieves list of branches for a given owner and repository", "description": "Retrieves branch data for a given owner and repository.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true }, { "in": "path", "name": "repository", "schema": { "type": "string" }, "description": "The name of the repository.", "required": true }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "description": "The number of results to return. If not specified, defaults to 20." }, { "in": "query", "name": "navigation", "schema": { "type": "string" }, "description": "Whether to get the previous or next page from paginated results. Use `next` for forward pagination after the cursor or `prev` for backward pagination before the cursor. If not specified, defaults to `next`. If no cursor is provided, the cursor is the beginning of the result set." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The cursor pointing to a specific position in the result set to start the query from. Results after the cursor will be returned if used with `next` or before the cursor if used with `prev` for `navigation`." }, { "in": "query", "name": "term", "schema": { "type": "string" }, "description": "The term substring to filter name strings by using the `contains` operator." } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for repository branches response", "properties": { "defaultBranch": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "description": "Serializer for individual branch nodes from GraphQL response", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "pageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "totalCount": { "type": "integer" } }, "required": [ "defaultBranch", "pageInfo", "results", "totalCount" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repository/{repository}/test-results/": { "get": { "operationId": "Retrieve paginated list of test results for repository, owner, and organization", "description": "Retrieves the list of test results for a given repository and owner. Also accepts a number of query parameters to filter the results.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true }, { "in": "path", "name": "repository", "schema": { "type": "string" }, "description": "The name of the repository.", "required": true }, { "in": "query", "name": "sortBy", "schema": { "type": "string" }, "description": "The property to sort results by. If not specified, the default is `TOTAL_FAIL_COUNT` in descending order. Use `-`\n for descending order.\n\nAvailable fields are:\n- `AVG_DURATION`\n- `FLAKE_RATE`\n- `FAILURE_RATE`\n- `TOTAL_FAIL_COUNT`\n- `UPDATED_AT`\n " }, { "in": "query", "name": "filterBy", "schema": { "type": "string" }, "description": "An optional field to filter by, which will constrain the results to only include tests that match the filter.\n\nAvailable fields are:\n- `FLAKY_TESTS`\n- `FAILED_TESTS`\n- `SLOWEST_TESTS`\n- `SKIPPED_TESTS`\n " }, { "in": "query", "name": "interval", "schema": { "type": "string" }, "description": "The time interval to search for results by.\n\nAvailable fields are:\n- `INTERVAL_30_DAY`\n- `INTERVAL_7_DAY`\n- `INTERVAL_1_DAY`\n" }, { "in": "query", "name": "branch", "schema": { "type": "string" }, "description": "The branch to search for results by. If not specified, the default is all branches.\n " }, { "in": "query", "name": "limit", "schema": { "type": "integer" }, "description": "The number of results to return. If not specified, defaults to 20." }, { "in": "query", "name": "navigation", "schema": { "type": "string" }, "description": "Whether to get the previous or next page from paginated results. Use `next` for forward pagination after the cursor or `prev` for backward pagination before the cursor. If not specified, defaults to `next`. If no cursor is provided, the cursor is the beginning of the result set." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The cursor pointing to a specific position in the result set to start the query from. Results after the cursor will be returned if used with `next` or before the cursor if used with `prev` for `navigation`." }, { "in": "query", "name": "term", "schema": { "type": "string" }, "description": "The term substring to filter name strings by using the `contains` operator." } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for test results response including pagination metadata", "properties": { "defaultBranch": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "description": "Serializer for individual test result nodes from GraphQL response", "properties": { "updatedAt": { "type": "string" }, "avgDuration": { "type": "number", "format": "double" }, "totalDuration": { "type": "number", "format": "double" }, "name": { "type": "string" }, "failureRate": { "type": "number", "format": "double" }, "flakeRate": { "type": "number", "format": "double" }, "totalFailCount": { "type": "integer" }, "totalFlakyFailCount": { "type": "integer" }, "totalSkipCount": { "type": "integer" }, "totalPassCount": { "type": "integer" }, "lastDuration": { "type": "number", "format": "double" } }, "required": [ "avgDuration", "failureRate", "flakeRate", "lastDuration", "name", "totalDuration", "totalFailCount", "totalFlakyFailCount", "totalPassCount", "totalSkipCount", "updatedAt" ] } }, "pageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "totalCount": { "type": "integer" } }, "required": [ "defaultBranch", "pageInfo", "results", "totalCount" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repository/{repository}/test-results-aggregates/": { "get": { "operationId": "Retrieve aggregated test result metrics for repository, owner, and organization", "description": "Retrieves aggregated test result metrics for a given repository and owner.\nAlso accepts a query parameter to specify the time period for the metrics.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true }, { "in": "path", "name": "repository", "schema": { "type": "string" }, "description": "The name of the repository.", "required": true }, { "in": "query", "name": "interval", "schema": { "type": "string" }, "description": "The time interval to search for results by.\n\nAvailable fields are:\n- `INTERVAL_30_DAY`\n- `INTERVAL_7_DAY`\n- `INTERVAL_1_DAY`\n" }, { "in": "query", "name": "branch", "schema": { "type": "string" }, "description": "The branch to search for results by. If not specified, the default is all branches.\n " } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for test results aggregates response", "properties": { "totalDuration": { "type": "number", "format": "double" }, "totalDurationPercentChange": { "type": "number", "format": "double" }, "slowestTestsDuration": { "type": "number", "format": "double" }, "slowestTestsDurationPercentChange": { "type": "number", "format": "double" }, "totalSlowTests": { "type": "integer" }, "totalSlowTestsPercentChange": { "type": "number", "format": "double" }, "totalFails": { "type": "integer" }, "totalFailsPercentChange": { "type": "number", "format": "double" }, "totalSkips": { "type": "integer" }, "totalSkipsPercentChange": { "type": "number", "format": "double" }, "flakeCount": { "type": "integer" }, "flakeCountPercentChange": { "type": "number", "format": "double" }, "flakeRate": { "type": "number", "format": "double" }, "flakeRatePercentChange": { "type": "number", "format": "double" } }, "required": [ "flakeCount", "flakeCountPercentChange", "flakeRate", "flakeRatePercentChange", "slowestTestsDuration", "slowestTestsDurationPercentChange", "totalDuration", "totalDurationPercentChange", "totalFails", "totalFailsPercentChange", "totalSkips", "totalSkipsPercentChange", "totalSlowTests", "totalSlowTestsPercentChange" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repository/{repository}/test-suites/": { "get": { "operationId": "Retrieve test suites belonging to a repository's test results", "description": "Retrieves test suites belonging to a repository's test results.\nIt accepts a list of test suites as a query parameter to specify individual test suites.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true }, { "in": "path", "name": "repository", "schema": { "type": "string" }, "description": "The name of the repository.", "required": true }, { "in": "query", "name": "term", "schema": { "type": "string" }, "description": "The term substring to filter name strings by using the `contains` operator." } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for test suites belonging to a repository's test results", "properties": { "testSuites": { "type": "array", "items": { "type": "string" } } }, "required": [ "testSuites" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/prevent/owner/{owner}/repository/{repository}/token/regenerate/": { "post": { "operationId": "Regenerates a repository upload token and returns the new token", "description": "Regenerates a repository upload token and returns the new token.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "owner", "schema": { "type": "string" }, "description": "The owner of the repository.", "required": true }, { "in": "path", "name": "repository", "schema": { "type": "string" }, "description": "The name of the repository.", "required": true } ], "tags": [ "Prevent" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for repositories response", "properties": { "token": { "type": "string" } }, "required": [ "token" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/project-keys/": { "get": { "operationId": "List an Organization's Client Keys", "description": "Return a list of client keys (DSNs) for all projects in an organization.\n\nThis paginated endpoint lists client keys across all projects in an organization. Each key includes the project ID\nto identify which project it belongs to.\n\nQuery Parameters:\n- team: Filter by team slug or ID to get keys only for that team's projects\n- status: Filter by 'active' or 'inactive' to get keys with specific status", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, { "in": "query", "name": "team", "schema": { "type": "string", "minLength": 1 }, "description": "Filter keys by team slug or ID. If provided, only keys for projects belonging to this team will be returned." }, { "in": "query", "name": "status", "schema": { "enum": [ "active", "inactive" ], "type": "string", "minLength": 1 }, "description": "Filter keys by status. Options are 'active' or 'inactive'.\n\n* `active`\n* `inactive`" } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "This represents a Sentry Project Client Key.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "public": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "projectId": { "type": "integer" }, "isActive": { "type": "boolean" }, "rateLimit": { "type": "object", "properties": { "window": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "count", "window" ], "nullable": true }, "dsn": { "type": "object", "properties": { "secret": { "type": "string" }, "public": { "type": "string" }, "csp": { "type": "string" }, "security": { "type": "string" }, "minidump": { "type": "string" }, "nel": { "type": "string" }, "unreal": { "type": "string" }, "crons": { "type": "string" }, "cdn": { "type": "string" }, "playstation": { "type": "string" }, "integration": { "type": "string" }, "otlp_traces": { "type": "string" }, "otlp_logs": { "type": "string" } }, "required": [ "cdn", "crons", "csp", "integration", "minidump", "nel", "otlp_logs", "otlp_traces", "playstation", "public", "secret", "security", "unreal" ] }, "browserSdkVersion": { "type": "string" }, "browserSdk": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "choices" ] }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dynamicSdkLoaderOptions": { "type": "object", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } }, "required": [ "hasDebug", "hasFeedback", "hasLogsAndMetrics", "hasPerformance", "hasReplay" ] }, "useCase": { "type": "string" } }, "required": [ "browserSdk", "browserSdkVersion", "dateCreated", "dsn", "dynamicSdkLoaderOptions", "id", "isActive", "label", "name", "projectId", "public", "rateLimit", "secret" ] } }, "examples": { "ListClientKeysForAllProjectsInAnOrganization": { "value": [ { "id": "60120449b6b1d5e45f75561e6dabd80b", "name": "Liked Pegasus", "label": "Liked Pegasus", "public": "60120449b6b1d5e45f75561e6dabd80b", "secret": "189485c3b8ccf582bf5e12c530ef8858", "projectId": 4505281256090153, "isActive": true, "rateLimit": { "window": 7200, "count": 1000 }, "dsn": { "secret": "https://a785682ddda742d7a8a4088810e67701:bcd99b3790b3441c85ce4b1eaa854f66@o4504765715316736.ingest.sentry.io/4505281256090153", "public": "https://a785682ddda742d7a8a4088810e67791@o4504765715316736.ingest.sentry.io/4505281256090153", "csp": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/csp-report/?sentry_key=a785682ddda719b7a8a4011110d75598", "security": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/security/?sentry_key=a785682ddda719b7a8a4011110d75598", "minidump": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/minidump/?sentry_key=a785682ddda719b7a8a4011110d75598", "playstation": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/playstation/?sentry_key=a785682ddda719b7a8a4011110d75598", "integration": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/", "otlp_traces": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/traces", "otlp_logs": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/logs", "nel": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/nel/?sentry_key=a785682ddda719b7a8a4011110d75598", "unreal": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/unreal/a785682ddda719b7a8a4011110d75598/", "cdn": "https://js.sentry-cdn.com/a785682ddda719b7a8a4011110d75598.min.js", "crons": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/crons/___MONITOR_SLUG___/a785682ddda719b7a8a4011110d75598/" }, "browserSdkVersion": "7.x", "browserSdk": { "choices": [ [ "latest", "latest" ], [ "7.x", "7.x" ] ] }, "dateCreated": "2023-06-21T19:50:26.036254Z", "dynamicSdkLoaderOptions": { "hasReplay": true, "hasPerformance": true, "hasDebug": true, "hasFeedback": false, "hasLogsAndMetrics": false } }, { "id": "da8d69cb17e80677b76e08fde4656b93", "name": "Bold Oarfish", "label": "Bold Oarfish", "public": "da8d69cb17e80677b76e08fde4656b93", "secret": "5c241ebc42ccfbec281cbefbedc7ab96", "projectId": 4505281256090153, "isActive": true, "rateLimit": null, "dsn": { "secret": "https://a785682ddda742d7a8a4088810e67701:bcd99b3790b3441c85ce4b1eaa854f66@o4504765715316736.ingest.sentry.io/4505281256090153", "public": "https://a785682ddda742d7a8a4088810e67791@o4504765715316736.ingest.sentry.io/4505281256090153", "csp": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/csp-report/?sentry_key=a785682ddda719b7a8a4011110d75598", "security": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/security/?sentry_key=a785682ddda719b7a8a4011110d75598", "minidump": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/minidump/?sentry_key=a785682ddda719b7a8a4011110d75598", "playstation": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/playstation/?sentry_key=a785682ddda719b7a8a4011110d75598", "integration": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/", "otlp_traces": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/traces", "otlp_logs": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/logs", "nel": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/nel/?sentry_key=a785682ddda719b7a8a4011110d75598", "unreal": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/unreal/a785682ddda719b7a8a4011110d75598/", "cdn": "https://js.sentry-cdn.com/a785682ddda719b7a8a4011110d75598.min.js", "crons": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/crons/___MONITOR_SLUG___/a785682ddda719b7a8a4011110d75598/" }, "browserSdkVersion": "7.x", "browserSdk": { "choices": [ [ "latest", "latest" ], [ "7.x", "7.x" ] ] }, "dateCreated": "2023-06-21T19:50:26.036254Z", "dynamicSdkLoaderOptions": { "hasReplay": true, "hasPerformance": true, "hasDebug": true, "hasFeedback": false, "hasLogsAndMetrics": false } } ], "summary": "List client keys for all projects in an organization" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/projects/": { "get": { "operationId": "List an Organization's Projects", "description": "Return a list of projects bound to a organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "latestDeploys": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "nullable": true }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "hasUserReports": { "type": "boolean" }, "environments": { "type": "array", "items": { "type": "string" } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true } }, "required": [ "access", "dateCreated", "environments", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "hasUserReports", "id", "isBookmarked", "isMember", "latestRelease", "name", "platform", "platforms", "slug", "team", "teams" ] } }, "examples": { "ListAnOrganization'sProjects": { "value": [ { "slug": "prime-mover", "name": "Prime Mover", "dateCreated": "2018-11-06T21:19:58.536Z", "firstEvent": null, "access": [], "hasAccess": true, "id": "3", "isBookmarked": false, "isMember": true, "platform": "", "platforms": [], "team": { "id": "2", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" }, "teams": [ { "id": "2", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" } ], "environments": [ "local" ], "features": [ "releases" ], "firstTransactionEvent": true, "hasSessions": true, "hasProfiles": true, "hasReplays": true, "hasFlags": true, "hasMinifiedStackTrace": false, "hasMonitors": true, "hasFeedbacks": false, "hasNewFeedbacks": false, "hasUserReports": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "latestRelease": null } ], "summary": "List an organization's projects" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/projects/{project_id_or_slug}/detectors/": { "post": { "operationId": "Create a Monitor for a Project", "description": "Create a Monitor for a project", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Monitors" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "name": { "type": "string", "description": "Name of the monitor.", "maxLength": 200 }, "type": { "type": "string", "description": "The type of monitor - `metric_issue`." }, "workflow_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the alerts to connect this monitor to. Use the 'Fetch Alerts' endpoint to find the IDs." }, "data_sources": { "type": "array", "items": {}, "description": "\n The data sources for the monitor to use based on what you want to measure.\n\n **Number of Errors Metric Monitor**\n - `eventTypes`: Any of `error` or `default`.\n ```json\n [\n {\n \"aggregate\": \"count()\",\n \"dataset\" : \"events\",\n \"environment\": \"prod\",\n \"eventTypes\": [\"default\", \"error\"],\n \"query\": \"is:unresolved\",\n \"queryType\": 0,\n \"timeWindow\": 3600,\n },\n ],\n ```\n\n **Users Experiencing Errors Metric Monitor**\n - `eventTypes`: Any of `error` or `default`.\n ```json\n [\n {\n \"aggregate\": \"count_unique(tags[sentry:user])\",\n \"dataset\" : \"events\",\n \"environment\": \"prod\",\n \"eventTypes\": [\"default\", \"error\"],\n \"query\": \"is:unresolved\",\n \"queryType\": 0,\n \"timeWindow\": 3600,\n },\n ],\n ```\n\n\n **Throughput Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"count(span.duration)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Duration Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"p95(span.duration)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Failure Rate Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"failure_rate()\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Largest Contentful Paint Metric Monitor**\n - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.\n - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile.\n\n ```json\n [\n {\n \"aggregate\":\"p95(measurements.lcp)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Custom Metric Monitor**\n - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.\n - `aggregate`: Valid values are:\n `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p75(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile.\n `failure_rate()`\n `apdex(x)`, where `x` is the value of the Apdex score.\n `count()`\n\n ```json\n [\n {\n \"aggregate\": \"p75(measurements.ttfb)\"\n \"dataset\": \"events_analytics_platform\",\n \"queryType\": 1,\n },\n ],\n" }, "config": { "type": "object", "additionalProperties": {}, "description": "\n The issue detection type configuration.\n\n\n - `detectionType`\n - `static`: Threshold based monitor\n - `percent`: Change based monitor\n - `dynamic`: Dynamic monitor\n - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes.\n For example, a value of 3600 compares the metric tracked against data 1 hour ago.\n - `300`: 5 minutes\n - `900`: 15 minutes\n - `3600`: 1 hour\n - `86400`: 1 day\n - `604800`: 1 week\n - `2592000`: 1 month\n\n **Threshold**\n ```json\n {\n \"detectionType\": \"static\",\n }\n ```\n **Change**\n ```json\n {\n \"detectionType\": \"percent\",\n \"comparisonDelta\": 3600,\n }\n ```\n **Dynamic**\n ```json\n {\n \"detectionType\": \"dynamic\",\n }\n ```\n " }, "condition_group": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "logic_type": { "enum": [ "any", "any-short", "all", "none" ], "type": "string", "description": "* `any`\n* `any-short`\n* `all`\n* `none`" }, "conditions": { "type": "array", "items": {} } }, "required": [ "logic_type" ] } ], "description": "\n Issue detection configuration for when to create an issue and at what priority level.\n\n\n - `logicType`: `any`\n - `type`: Any of `gt` (greater than), `lte` (less than or equal), or `anomaly_detection` (dynamic)\n - `comparison`: Any positive integer. This is threshold that must be crossed for the monitor to create an issue, e.g. \"Create a metric issue when there are more than 5 unresolved error events\".\n - If creating a **dynamic** monitor, see the options below.\n - `seasonality`: `auto`\n - `sensitivity`: Level of responsiveness. Options are one of `low`, `medium`, or `high`\n - `thresholdType`: If you want to be alerted to anomalies that are moving above, below, or in both directions in relation to your threshold.\n - `0`: Above\n - `1`: Below\n - `2`: Above and below\n\n - `conditionResult`: The issue state change when the threshold is crossed.\n - `75`: High priority\n - `50`: Low priority\n - `0`: Resolved\n\n\n **Threshold and Change Monitor**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"gt\",\n \"comparison\": 10,\n \"conditionResult\": 75\n },\n {\n \"type\": \"lte\",\n \"comparison\": 10,\n \"conditionResult\": 0\n }\n ],\n \"actions\": []\n ```\n\n **Threshold Monitor with Medium Priority**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n type: \"gt\",\n comparison: 5,\n conditionResult: 75\n },\n {\n type: \"gt\",\n comparison: 2,\n conditionResult: 50\n },\n {\n type: \"lte\",\n comparison: 2,\n conditionResult: 0\n }\n ],\n \"actions\": []\n ```\n\n **Dynamic Monitor**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"anomaly_detection\",\n \"comparison\": {\n \"seasonality\": \"auto\",\n \"sensitivity\": \"medium\",\n \"thresholdType\": 2\n },\n \"conditionResult\": 75\n }\n ],\n \"actions\": []\n ```\n " }, "owner": { "type": "string", "nullable": true, "description": "\n The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'.\n\n **User**\n ```json\n \"user:123456\"\n ```\n\n **Team**\n ```json\n \"team:456789\"\n ```\n " }, "description": { "type": "string", "nullable": true, "description": "A description of the monitor. Will be used in the resulting issue." }, "enabled": { "type": "boolean", "description": "Set to False if you want to disable the monitor." } }, "required": [ "name", "type" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "project:admin", "project:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ], "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "latestGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "workflowIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dataSources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true }, "conditionGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "enabled": { "type": "boolean" }, "openIssues": { "type": "integer" } }, "required": [ "conditionGroup", "config", "dataSources", "dateCreated", "dateUpdated", "enabled", "id", "name", "openIssues", "projectId", "type", "workflowIds" ] }, "examples": { "MonitorSuccessfullyCreated": { "value": { "id": "12345", "projectId": "1", "name": "Example metric monitor", "description": "Example description", "type": "metric_issue", "workflowIds": [], "owner": { "type": "user", "id": "12345", "name": "Jane Doe", "email": "jane@sentry.io" }, "createdBy": "12345", "dateCreated": "2026-01-08T23:45:13.235259Z", "dateUpdated": "2026-01-08T23:45:13.235243Z", "dataSources": [ { "id": "123456", "organizationId": "1", "type": "snuba_query_subscription", "sourceId": "12345", "queryObj": { "id": "23456", "status": 1, "subscription": null, "snubaQuery": { "id": "45678", "dataset": "events", "query": "is:unresolved", "aggregate": "count()", "timeWindow": 3600, "environment": null, "eventTypes": [ "error", "default" ], "extrapolationMode": "unknown" } } } ], "conditionGroup": { "id": "1234567", "organizationId": "1", "logicType": "any", "conditions": [ { "id": "2345677", "type": "gt", "comparison": 10, "conditionResult": 75 }, { "id": "567891", "type": "lte", "comparison": 10, "conditionResult": 0 } ], "actions": [] }, "config": { "detectionType": "static" }, "enabled": true, "latestGroup": null, "openIssues": 0 }, "summary": "Monitor successfully created" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/relay_usage/": { "get": { "operationId": "List an Organization's trusted Relays", "description": "Return a list of trusted relays bound to an organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "relayId": { "type": "string" }, "version": { "type": "string" }, "publicKey": { "type": "string" }, "firstSeen": { "type": "string" }, "lastSeen": { "type": "string" } }, "required": [ "firstSeen", "lastSeen", "publicKey", "relayId", "version" ] } }, "examples": { "ListAnOrganization'sTrustedRelays": { "value": [ { "relayId": "0123abcd-4567-efgh-ij89-012aaa456bbb", "version": "23.11.2", "firstSeen": "2023-12-10T00:00:00.000000Z", "lastSeen": "2023-12-20T22:22:22.222222Z", "publicKey": "asdfa54g9987ga9dfha0f8adfhkj324-dafd78321-I" } ], "summary": "List an organization's trusted relays" } } } }, "description": "" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/release-threshold-statuses/": { "get": { "operationId": "Retrieve Statuses of Release Thresholds (Alpha)", "description": "**`[WARNING]`**: This API is an experimental Alpha feature and is subject to change!\n\nList all derived statuses of releases that fall within the provided start/end datetimes.\n\nConstructs a response key'd off \\{`release_version`\\}-\\{`project_slug`\\} that lists thresholds with their status for *specified* projects.\nEach returned enriched threshold will contain the full serialized `release_threshold` instance as well as it's derived health statuses.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "The start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end`.", "required": true }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "The inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start`.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "A list of environment names to filter your results by." }, { "in": "query", "name": "projectSlug", "schema": { "type": "array", "items": { "type": "string" } }, "description": "A list of project slugs to filter your results by." }, { "in": "query", "name": "release", "schema": { "type": "array", "items": { "type": "string" } }, "description": "A list of release versions to filter your results by." } ], "tags": [ "Releases" ], "security": [ { "auth_token": [ "org:ci", "project:admin", "project:read", "project:releases", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "environment": { "type": "object", "additionalProperties": {}, "nullable": true }, "project": { "type": "object", "additionalProperties": {} }, "release": { "type": "string" }, "threshold_type": { "type": "integer" }, "trigger_type": { "type": "string" }, "value": { "type": "integer" }, "window_in_seconds": { "type": "integer" }, "end": { "type": "string", "format": "date-time" }, "is_healthy": { "type": "boolean" }, "key": { "type": "string" }, "project_slug": { "type": "string" }, "project_id": { "type": "integer" }, "start": { "type": "string", "format": "date-time" }, "metric_value": { "anyOf": [ { "type": "integer" }, { "type": "number", "format": "double" }, { "type": "object", "nullable": true } ] } }, "required": [ "end", "is_healthy", "key", "metric_value", "project_id", "project_slug", "start" ] } } }, "examples": { "ClientKeyWithRateLimiting": { "value": { "the-spoiled-yoghurt-v1.0.0": [ { "project_id": 0, "project_slug": "the-spoiled-yoghurt", "environment": { "name": "production" }, "project": { "id": "4505321021243392", "slug": "the-spoiled-yoghurt", "name": "The Spoiled Yoghurt", "platform": "python", "dateCreated": "2023-06-08T00:13:06.004534Z", "isBookmarked": false, "isMember": true, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": null, "firstTransactionEvent": false, "access": [ "member:read", "event:read", "project:admin", "team:write", "project:write", "team:admin", "project:read", "org:integrations", "org:read", "project:releases", "team:read", "alerts:write", "event:admin", "event:write", "alerts:read" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasFeedbacks": false, "hasMonitors": false, "hasNewFeedbacks": false, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasSessions": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#3f70bf", "status": "active" }, "threshold_type": 0, "trigger_type": "over", "value": 100, "window_in_seconds": 600, "key": "foobar-v1.0.0", "release": "the-spoiled-yoghurt-v1.0.0", "is_healthy": true, "start": "2022-02-14T19:00:00Z", "end": "2022-02-28T18:03:00Z", "metric_value": 0.1 } ] }, "summary": "Client key with rate limiting" } } } }, "description": "" }, "400": { "description": "Bad Request" } } } }, "/api/0/organizations/{organization_id_or_slug}/releases/{version}/": { "get": { "operationId": "Retrieve an Organization's Release", "description": "Return details on an individual release.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "version", "schema": { "type": "string" }, "description": "The version identifier of the release", "required": true }, { "in": "query", "name": "project_id", "schema": { "type": "string" }, "description": "The project ID to filter by." }, { "in": "query", "name": "health", "schema": { "type": "boolean" }, "description": "Whether or not to include health data with the release. By default, this is false." }, { "in": "query", "name": "adoptionStages", "schema": { "type": "boolean" }, "description": "Whether or not to include adoption stages with the release. By default, this is false." }, { "in": "query", "name": "summaryStatsPeriod", "schema": { "type": "string", "enum": [ "14d", "1d", "1h", "24h", "2d", "30d", "48h", "7d", "90d" ] }, "description": "The period of time used to query summary stats for the release. By default, this is 14d." }, { "in": "query", "name": "healthStatsPeriod", "schema": { "type": "string", "enum": [ "14d", "1d", "1h", "24h", "2d", "30d", "48h", "7d", "90d" ] }, "description": "The period of time used to query health stats for the release. By default, this is 24h if health is enabled." }, { "in": "query", "name": "sort", "schema": { "type": "string", "enum": [ "crash_free_sessions", "crash_free_users", "date", "sessions", "users" ] }, "description": "The field used to sort results by. By default, this is `date`." }, { "in": "query", "name": "status", "schema": { "type": "string", "enum": [ "archived", "open" ] }, "description": "Release statuses that you can filter by." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Filters results by using [query syntax](/product/sentry-basics/search/).\n\nExample: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`\n" } ], "tags": [ "Releases" ], "security": [ { "auth_token": [ "org:ci", "project:admin", "project:read", "project:releases", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ref": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "object", "additionalProperties": {}, "nullable": true }, "lastCommit": { "type": "object", "additionalProperties": {}, "nullable": true }, "lastDeploy": { "type": "object", "properties": { "dateStarted": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "id": { "type": "string" }, "environment": { "type": "string" }, "dateFinished": { "type": "string" }, "name": { "type": "string" } }, "required": [ "dateFinished", "environment", "id", "name" ], "nullable": true }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "lastEvent": { "type": "string", "format": "date-time", "nullable": true }, "currentProjectMeta": { "type": "object", "additionalProperties": {}, "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "adoptionStages": { "type": "object", "additionalProperties": {}, "nullable": true }, "id": { "type": "integer" }, "version": { "type": "string" }, "newGroups": { "type": "integer" }, "status": { "type": "string" }, "shortVersion": { "type": "string" }, "versionInfo": { "type": "object", "properties": { "description": { "type": "string" }, "package": { "type": "string", "nullable": true }, "version": { "type": "object", "additionalProperties": {} }, "buildHash": { "type": "string", "nullable": true } }, "required": [ "buildHash", "package", "version" ], "nullable": true }, "data": { "type": "object", "additionalProperties": {} }, "commitCount": { "type": "integer" }, "deployCount": { "type": "integer" }, "authors": { "type": "array", "items": { "type": "object", "properties": { "lastLogin": { "type": "string" }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string" }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number", "format": "double" }, { "type": "boolean" }, { "type": "object", "nullable": true } ] } }, "emails": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "boolean" } ] } } }, "avatar": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "id": { "type": "integer" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string" } }, "required": [ "avatarUrl", "dateJoined", "email", "hasPasswordAuth", "id", "isActive", "isManaged", "isSuspended", "name", "username" ] } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "healthData": { "type": "object", "properties": { "durationP50": { "type": "number", "format": "double", "nullable": true }, "durationP90": { "type": "number", "format": "double", "nullable": true }, "crashFreeUsers": { "type": "number", "format": "double", "nullable": true }, "crashFreeSessions": { "type": "number", "format": "double", "nullable": true }, "totalUsers": { "type": "integer", "nullable": true }, "totalUsers24h": { "type": "integer", "nullable": true }, "totalProjectUsers24h": { "type": "integer", "nullable": true }, "totalSessions": { "type": "integer", "nullable": true }, "totalSessions24h": { "type": "integer", "nullable": true }, "totalProjectSessions24h": { "type": "integer", "nullable": true }, "adoption": { "type": "number", "format": "double", "nullable": true }, "sessionsAdoption": { "type": "number", "format": "double", "nullable": true }, "sessionsCrashed": { "type": "integer" }, "sessionsErrored": { "type": "integer" }, "hasHealthData": { "type": "boolean" }, "stats": { "type": "object", "additionalProperties": {} } }, "required": [ "hasHealthData", "sessionsCrashed", "sessionsErrored", "stats" ], "nullable": true }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "platforms": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hasHealthData": { "type": "boolean" }, "newGroups": { "type": "integer" } }, "required": [ "hasHealthData", "id", "name", "newGroups", "platform", "platforms", "slug" ] } } }, "required": [ "authors", "commitCount", "data", "deployCount", "id", "newGroups", "projects", "shortVersion", "status", "version", "versionInfo" ] }, "examples": { "RetrieveReleaseDetails": { "value": { "id": 1122684517, "version": "control@abc123", "status": "open", "shortVersion": "control@abc123", "versionInfo": { "package": "control", "version": { "raw": "abc123" }, "description": "abc123", "buildHash": "abc123" }, "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T11:26:16.190281Z", "data": {}, "newGroups": 0, "owner": null, "commitCount": 2, "lastCommit": { "id": "xyz123", "message": "feat(raspberries): Made raspberries even more delicious", "dateCreated": "2024-05-21T11:04:55Z", "pullRequest": { "id": "70214", "title": "feat(raspberries): Made raspberries even more delicious", "message": "Made raspberries even more delicious", "dateCreated": "2024-05-03T07:32:28.205043Z", "repository": { "id": "1", "name": "raj/raspberries", "url": "https://raspberries.raspberries/raj/raspberries", "provider": { "id": "integrations:github", "name": "GitHub" }, "status": "active", "dateCreated": "2016-10-10T21:36:42.414678Z", "integrationId": "2933", "externalSlug": "raj/raspberries", "externalId": "873328" }, "author": { "id": "2837091", "name": "Raj's Raspberries", "username": "rajraspberry", "avatarUrl": "https://gravatar.com/avatar/bf99685de539465db9208ab3a888843ba0e5e85b1f156084484c7c6c31312be5?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": false, "isManaged": false, "dateJoined": "2023-08-07T12:32:09.091427Z", "lastLogin": "2024-05-21T05:46:23.824074Z", "has2fa": true, "lastActive": "2024-05-21T13:59:10.614891Z", "isSuperuser": true, "isStaff": true, "experiments": {}, "emails": [ { "id": "2972219", "email": "raj@raspberries", "is_verified": true } ], "avatar": { "avatarType": "upload", "avatarUuid": "xyz123", "avatarUrl": "https://sentry.io/avatar/xyz123/" } }, "externalUrl": "https://github.com/raj/raspberries/pull/70214" }, "suspectCommitType": "", "repository": { "id": "1", "name": "raj/raspberries", "url": "https://github.com/raj/raspberries", "provider": { "id": "integrations:github", "name": "GitHub" }, "status": "active", "dateCreated": "2016-10-10T21:36:42.414678Z", "integrationId": "2933", "externalSlug": "raj/raspberries", "externalId": "873328" }, "author": { "id": "2837091", "name": "Raj's Raspberries", "username": "rajraspberry", "avatarUrl": "https://gravatar.com/avatar/bf99685de539465db9208ab3a888843ba0e5e85b1f156084484c7c6c31312be5?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": false, "isManaged": false, "dateJoined": "2023-08-07T12:32:09.091427Z", "lastLogin": "2024-05-21T05:46:23.824074Z", "has2fa": true, "lastActive": "2024-05-21T13:59:10.614891Z", "isSuperuser": true, "isStaff": true, "experiments": {}, "emails": [ { "id": "2972219", "email": "raj@raspberries", "is_verified": true } ], "avatar": { "avatarType": "upload", "avatarUuid": "xyz123", "avatarUrl": "https://sentry.io/avatar/xyz123/" } }, "releases": [ { "version": "control@abc123", "shortVersion": "control@abc123", "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T11:26:16.190281Z" }, { "version": "backend@abc123", "shortVersion": "backend@abc123", "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T11:56:36.790866Z" }, { "version": "control@def789", "shortVersion": "control@def789", "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T12:44:25.923663Z" }, { "version": "frontend@ghi012", "shortVersion": "frontend@ghi012", "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T12:46:42.338358Z" } ] }, "deployCount": 1, "lastDeploy": { "id": "53070941", "environment": "canary-test-control", "dateStarted": null, "dateFinished": "2024-05-21T11:26:17.597793Z", "name": "control@abc123 to canary-test-", "url": null }, "authors": [ { "id": 2837091, "name": "Raj's Raspberries", "username": "rajraspberry", "email": "raj@raspberries", "avatarUrl": "https://gravatar.com/avatar/bf99685de539465db9208ab3a888843ba0e5e85b1f156084484c7c6c31312be5?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": false, "isManaged": false, "dateJoined": "2023-08-07T12:32:09.091427Z", "lastLogin": "2024-05-21T05:46:23.824074Z", "has2fa": true, "lastActive": "2024-05-21T13:59:10.614891Z", "isSuperuser": true, "isStaff": true, "experiments": {}, "emails": [ { "id": "2972219", "email": "raj@raspberries", "is_verified": true } ], "avatar": { "avatarType": "upload", "avatarUuid": "xyz123", "avatarUrl": "https://sentry.io/avatar/xyz123/" } } ], "projects": [ { "id": 1, "slug": "sentry", "name": "Backend", "newGroups": 0, "platform": "python", "platforms": [ "native", "other", "python" ], "hasHealthData": false, "healthData": { "durationP50": null, "durationP90": null, "crashFreeUsers": null, "crashFreeSessions": null, "sessionsCrashed": 0, "sessionsErrored": 0, "totalUsers": null, "totalUsers24h": null, "totalProjectUsers24h": null, "totalSessions": null, "totalSessions24h": null, "totalProjectSessions24h": null, "adoption": null, "sessionsAdoption": null, "stats": { "24h": [ [ 1715126400, 0 ], [ 1715212800, 0 ], [ 1715299200, 0 ], [ 1715385600, 0 ], [ 1715472000, 0 ], [ 1715558400, 0 ], [ 1715644800, 0 ], [ 1715731200, 0 ], [ 1715817600, 0 ], [ 1715904000, 0 ], [ 1715990400, 0 ], [ 1716076800, 0 ], [ 1716163200, 0 ], [ 1716249600, 0 ] ] }, "hasHealthData": false } } ], "firstEvent": null, "lastEvent": null, "currentProjectMeta": {}, "userAgent": "Python-urllib/3.11", "adoptionStages": { "sentry": { "stage": "low_adoption", "adopted": null, "unadopted": null } } }, "summary": "Retrieve release details" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update an Organization's Release", "description": "Update a release. This can change some metadata associated with\nthe release (the ref, url, and dates).", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "version", "schema": { "type": "string" }, "description": "The version identifier of the release", "required": true } ], "tags": [ "Releases" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ref": { "type": "string", "nullable": true, "description": "An optional commit reference. This is useful if a tagged version has been provided.", "maxLength": 200 }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "A URL that points to the release. For instance, this can be the path to an online interface to the source code, such as a GitHub URL." }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the release went live. If not provided the current time is used." }, "commits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 64 }, "repository": { "type": "string", "nullable": true, "maxLength": 64 }, "message": { "type": "string", "nullable": true }, "author_name": { "type": "string", "nullable": true, "maxLength": 128 }, "author_email": { "type": "string", "nullable": true, "maxLength": 200 }, "timestamp": { "type": "string", "format": "date-time", "nullable": true }, "patch_set": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "maxLength": 510 }, "type": { "type": "string", "maxLength": 1 } }, "required": [ "path", "type" ] }, "nullable": true } }, "required": [ "id" ] }, "description": "An optional list of commit data to be associated." }, "refs": { "type": "array", "items": { "type": "object", "properties": { "commit": { "type": "string" }, "repository": { "type": "string", "maxLength": 200 }, "previousCommit": { "type": "string", "nullable": true, "maxLength": 64 } }, "required": [ "commit", "repository" ] }, "description": "An optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters ``repository`` and ``commit`` (the HEAD SHA). For GitLab repositories, please use the Group name instead of the slug. They can optionally include ``previousCommit`` (the SHA of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data." } } } } } }, "security": [ { "auth_token": [ "org:ci", "project:admin", "project:releases", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ref": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "object", "additionalProperties": {}, "nullable": true }, "lastCommit": { "type": "object", "additionalProperties": {}, "nullable": true }, "lastDeploy": { "type": "object", "properties": { "dateStarted": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "id": { "type": "string" }, "environment": { "type": "string" }, "dateFinished": { "type": "string" }, "name": { "type": "string" } }, "required": [ "dateFinished", "environment", "id", "name" ], "nullable": true }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "lastEvent": { "type": "string", "format": "date-time", "nullable": true }, "currentProjectMeta": { "type": "object", "additionalProperties": {}, "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "adoptionStages": { "type": "object", "additionalProperties": {}, "nullable": true }, "id": { "type": "integer" }, "version": { "type": "string" }, "newGroups": { "type": "integer" }, "status": { "type": "string" }, "shortVersion": { "type": "string" }, "versionInfo": { "type": "object", "properties": { "description": { "type": "string" }, "package": { "type": "string", "nullable": true }, "version": { "type": "object", "additionalProperties": {} }, "buildHash": { "type": "string", "nullable": true } }, "required": [ "buildHash", "package", "version" ], "nullable": true }, "data": { "type": "object", "additionalProperties": {} }, "commitCount": { "type": "integer" }, "deployCount": { "type": "integer" }, "authors": { "type": "array", "items": { "type": "object", "properties": { "lastLogin": { "type": "string" }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string" }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number", "format": "double" }, { "type": "boolean" }, { "type": "object", "nullable": true } ] } }, "emails": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "boolean" } ] } } }, "avatar": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "id": { "type": "integer" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string" } }, "required": [ "avatarUrl", "dateJoined", "email", "hasPasswordAuth", "id", "isActive", "isManaged", "isSuspended", "name", "username" ] } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "healthData": { "type": "object", "properties": { "durationP50": { "type": "number", "format": "double", "nullable": true }, "durationP90": { "type": "number", "format": "double", "nullable": true }, "crashFreeUsers": { "type": "number", "format": "double", "nullable": true }, "crashFreeSessions": { "type": "number", "format": "double", "nullable": true }, "totalUsers": { "type": "integer", "nullable": true }, "totalUsers24h": { "type": "integer", "nullable": true }, "totalProjectUsers24h": { "type": "integer", "nullable": true }, "totalSessions": { "type": "integer", "nullable": true }, "totalSessions24h": { "type": "integer", "nullable": true }, "totalProjectSessions24h": { "type": "integer", "nullable": true }, "adoption": { "type": "number", "format": "double", "nullable": true }, "sessionsAdoption": { "type": "number", "format": "double", "nullable": true }, "sessionsCrashed": { "type": "integer" }, "sessionsErrored": { "type": "integer" }, "hasHealthData": { "type": "boolean" }, "stats": { "type": "object", "additionalProperties": {} } }, "required": [ "hasHealthData", "sessionsCrashed", "sessionsErrored", "stats" ], "nullable": true }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "platforms": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hasHealthData": { "type": "boolean" }, "newGroups": { "type": "integer" } }, "required": [ "hasHealthData", "id", "name", "newGroups", "platform", "platforms", "slug" ] } } }, "required": [ "authors", "commitCount", "data", "deployCount", "id", "newGroups", "projects", "shortVersion", "status", "version", "versionInfo" ] }, "examples": { "RetrieveReleaseDetails": { "value": { "id": 1122684517, "version": "control@abc123", "status": "open", "shortVersion": "control@abc123", "versionInfo": { "package": "control", "version": { "raw": "abc123" }, "description": "abc123", "buildHash": "abc123" }, "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T11:26:16.190281Z", "data": {}, "newGroups": 0, "owner": null, "commitCount": 2, "lastCommit": { "id": "xyz123", "message": "feat(raspberries): Made raspberries even more delicious", "dateCreated": "2024-05-21T11:04:55Z", "pullRequest": { "id": "70214", "title": "feat(raspberries): Made raspberries even more delicious", "message": "Made raspberries even more delicious", "dateCreated": "2024-05-03T07:32:28.205043Z", "repository": { "id": "1", "name": "raj/raspberries", "url": "https://raspberries.raspberries/raj/raspberries", "provider": { "id": "integrations:github", "name": "GitHub" }, "status": "active", "dateCreated": "2016-10-10T21:36:42.414678Z", "integrationId": "2933", "externalSlug": "raj/raspberries", "externalId": "873328" }, "author": { "id": "2837091", "name": "Raj's Raspberries", "username": "rajraspberry", "avatarUrl": "https://gravatar.com/avatar/bf99685de539465db9208ab3a888843ba0e5e85b1f156084484c7c6c31312be5?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": false, "isManaged": false, "dateJoined": "2023-08-07T12:32:09.091427Z", "lastLogin": "2024-05-21T05:46:23.824074Z", "has2fa": true, "lastActive": "2024-05-21T13:59:10.614891Z", "isSuperuser": true, "isStaff": true, "experiments": {}, "emails": [ { "id": "2972219", "email": "raj@raspberries", "is_verified": true } ], "avatar": { "avatarType": "upload", "avatarUuid": "xyz123", "avatarUrl": "https://sentry.io/avatar/xyz123/" } }, "externalUrl": "https://github.com/raj/raspberries/pull/70214" }, "suspectCommitType": "", "repository": { "id": "1", "name": "raj/raspberries", "url": "https://github.com/raj/raspberries", "provider": { "id": "integrations:github", "name": "GitHub" }, "status": "active", "dateCreated": "2016-10-10T21:36:42.414678Z", "integrationId": "2933", "externalSlug": "raj/raspberries", "externalId": "873328" }, "author": { "id": "2837091", "name": "Raj's Raspberries", "username": "rajraspberry", "avatarUrl": "https://gravatar.com/avatar/bf99685de539465db9208ab3a888843ba0e5e85b1f156084484c7c6c31312be5?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": false, "isManaged": false, "dateJoined": "2023-08-07T12:32:09.091427Z", "lastLogin": "2024-05-21T05:46:23.824074Z", "has2fa": true, "lastActive": "2024-05-21T13:59:10.614891Z", "isSuperuser": true, "isStaff": true, "experiments": {}, "emails": [ { "id": "2972219", "email": "raj@raspberries", "is_verified": true } ], "avatar": { "avatarType": "upload", "avatarUuid": "xyz123", "avatarUrl": "https://sentry.io/avatar/xyz123/" } }, "releases": [ { "version": "control@abc123", "shortVersion": "control@abc123", "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T11:26:16.190281Z" }, { "version": "backend@abc123", "shortVersion": "backend@abc123", "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T11:56:36.790866Z" }, { "version": "control@def789", "shortVersion": "control@def789", "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T12:44:25.923663Z" }, { "version": "frontend@ghi012", "shortVersion": "frontend@ghi012", "ref": null, "url": null, "dateReleased": null, "dateCreated": "2024-05-21T12:46:42.338358Z" } ] }, "deployCount": 1, "lastDeploy": { "id": "53070941", "environment": "canary-test-control", "dateStarted": null, "dateFinished": "2024-05-21T11:26:17.597793Z", "name": "control@abc123 to canary-test-", "url": null }, "authors": [ { "id": 2837091, "name": "Raj's Raspberries", "username": "rajraspberry", "email": "raj@raspberries", "avatarUrl": "https://gravatar.com/avatar/bf99685de539465db9208ab3a888843ba0e5e85b1f156084484c7c6c31312be5?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": false, "isManaged": false, "dateJoined": "2023-08-07T12:32:09.091427Z", "lastLogin": "2024-05-21T05:46:23.824074Z", "has2fa": true, "lastActive": "2024-05-21T13:59:10.614891Z", "isSuperuser": true, "isStaff": true, "experiments": {}, "emails": [ { "id": "2972219", "email": "raj@raspberries", "is_verified": true } ], "avatar": { "avatarType": "upload", "avatarUuid": "xyz123", "avatarUrl": "https://sentry.io/avatar/xyz123/" } } ], "projects": [ { "id": 1, "slug": "sentry", "name": "Backend", "newGroups": 0, "platform": "python", "platforms": [ "native", "other", "python" ], "hasHealthData": false, "healthData": { "durationP50": null, "durationP90": null, "crashFreeUsers": null, "crashFreeSessions": null, "sessionsCrashed": 0, "sessionsErrored": 0, "totalUsers": null, "totalUsers24h": null, "totalProjectUsers24h": null, "totalSessions": null, "totalSessions24h": null, "totalProjectSessions24h": null, "adoption": null, "sessionsAdoption": null, "stats": { "24h": [ [ 1715126400, 0 ], [ 1715212800, 0 ], [ 1715299200, 0 ], [ 1715385600, 0 ], [ 1715472000, 0 ], [ 1715558400, 0 ], [ 1715644800, 0 ], [ 1715731200, 0 ], [ 1715817600, 0 ], [ 1715904000, 0 ], [ 1715990400, 0 ], [ 1716076800, 0 ], [ 1716163200, 0 ], [ 1716249600, 0 ] ] }, "hasHealthData": false } } ], "firstEvent": null, "lastEvent": null, "currentProjectMeta": {}, "userAgent": "Python-urllib/3.11", "adoptionStages": { "sentry": { "stage": "low_adoption", "adopted": null, "unadopted": null } } }, "summary": "Retrieve release details" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete an Organization's Release", "description": "Permanently remove a release and all of its files.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "version", "schema": { "type": "string" }, "description": "The version identifier of the release", "required": true } ], "tags": [ "Releases" ], "security": [ { "auth_token": [ "project:admin", "project:releases" ] } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/releases/{version}/deploys/": { "get": { "operationId": "List a Release's Deploys", "description": "Returns a list of deploys based on the organization, version, and project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "version", "schema": { "type": "string" }, "description": "The version identifier of the release", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Releases" ], "security": [ { "auth_token": [ "org:ci", "project:admin", "project:read", "project:releases", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Serializer for Deploy response objects", "properties": { "id": { "type": "string", "description": "The ID of the deploy" }, "environment": { "type": "string", "description": "The environment name" }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the deploy started" }, "dateFinished": { "type": "string", "format": "date-time", "description": "An optional date that indicates when the deploy ended" }, "name": { "type": "string", "nullable": true, "description": "The optional name of the deploy" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The optional URL that points to the deploy" } }, "required": [ "dateFinished", "dateStarted", "environment", "id", "name", "url" ] } } } }, "description": "" } } }, "post": { "operationId": "Create a Deploy", "description": "Create a deploy for a given release.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "version", "schema": { "type": "string" }, "description": "The version identifier of the release", "required": true } ], "tags": [ "Releases" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "type": "string", "description": "The environment you're deploying to", "maxLength": 64 }, "name": { "type": "string", "nullable": true, "description": "The optional name of the deploy", "maxLength": 64 }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The optional URL that points to the deploy" }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the deploy started" }, "dateFinished": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the deploy ended. If not provided, the current time is used." }, "projects": { "type": "array", "items": { "type": "string" }, "description": "The optional list of project slugs to create a deploy within. If not provided, deploys are created for all of the release's projects." } }, "required": [ "environment" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:ci", "project:admin", "project:releases", "project:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "description": "Serializer for Deploy response objects", "properties": { "id": { "type": "string", "description": "The ID of the deploy" }, "environment": { "type": "string", "description": "The environment name" }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the deploy started" }, "dateFinished": { "type": "string", "format": "date-time", "description": "An optional date that indicates when the deploy ended" }, "name": { "type": "string", "nullable": true, "description": "The optional name of the deploy" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The optional URL that points to the deploy" } }, "required": [ "dateFinished", "dateStarted", "environment", "id", "name", "url" ] } } }, "description": "" }, "400": { "description": "Bad Request" } } } }, "/api/0/organizations/{organization_id_or_slug}/replay-count/": { "get": { "operationId": "Retrieve a Count of Replays for a Given Issue or Transaction", "description": "Return a count of replays for a list of issue or transaction IDs.\n\nThe `query` parameter is required. It is a search query that includes exactly one of `issue.id`, `transaction`, or `replay_id` (string or list of strings).", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string" }, "description": "The period of time for the query, will override the start & end parameters, a number followed by one of:\n- `d` for days\n- `h` for hours\n- `m` for minutes\n- `s` for seconds\n- `w` for weeks\n\nFor example, `24h`, to mean query data starting from 24 hours ago to now." }, { "in": "query", "name": "project_id_or_slug", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The project slugs to filter by. Use `$all` to include all available projects. For example, the following are valid parameters:\n- `/?projectSlug=$all`\n- `/?projectSlug=android&projectSlug=javascript-react`\n" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Filters results by using [query syntax](/product/sentry-basics/search/).\n\nExample: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`\n" } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer" } }, "examples": { "QueryReplayCountByIssueOrTransactionId": { "value": { "1": 9, "2": 0, "5": 0, "9": 1, "10": 29 }, "summary": "Query replay count by issue or transaction id" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/replay-selectors/": { "get": { "operationId": "List an Organization's Selectors", "description": "Return a list of selectors for a given organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The environment to filter by." }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string", "minLength": 1 }, "description": "This defines the range of the time series, relative to now. The range is given in a `` format. For example `1d` for a one day range. Possible units are `m` for minutes, `h` for hours, `d` for days and `w` for weeks.You must either provide a `statsPeriod`, or a `start` and `end`." }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds.Use along with `end` instead of `statsPeriod`." }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds.Use along with `start` instead of `statsPeriod`." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the projects to filter by." }, { "in": "query", "name": "projectSlug", "schema": { "type": "array", "items": { "type": "string" } }, "description": "A list of project slugs to filter your results by." }, { "in": "query", "name": "sort", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "sortBy", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "orderBy", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Filters results by using [query syntax](/product/sentry-basics/search/).\n\nExample: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`\n" } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count_dead_clicks": { "type": "integer" }, "count_rage_clicks": { "type": "integer" }, "dom_element": { "type": "string" }, "element": { "type": "object", "properties": { "alt": { "type": "string" }, "aria_label": { "type": "string" }, "class": { "type": "array", "items": { "type": "string" } }, "component_name": { "type": "string" }, "id": { "type": "string" }, "role": { "type": "string" }, "tag": { "type": "string" }, "testid": { "type": "string" }, "title": { "type": "string" } }, "required": [ "alt", "aria_label", "class", "component_name", "id", "role", "tag", "testid", "title" ] }, "project_id": { "type": "string" } } } } }, "required": [ "data" ] }, "examples": { "RetrieveACollectionOfSelectorsForAnOrganization.": { "value": { "data": [ { "count_dead_clicks": 2, "count_rage_clicks": 1, "dom_element": "div#myid.class1.class2", "element": { "alt": "", "aria_label": "", "class": [ "class1", "class2" ], "component_name": "", "id": "myid", "role": "", "tag": "div", "testid": "", "title": "" }, "project_id": "1" } ] }, "summary": "Retrieve a collection of selectors for an organization." } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/replays/": { "get": { "operationId": "List an Organization's Replays", "description": "Return a list of replays belonging to an organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string", "minLength": 1 }, "description": "\nThis defines the range of the time series, relative to now. The range is given in a\n`` format. For example `1d` for a one day range. Possible units are `m` for\nminutes, `h` for hours, `d` for days and `w` for weeks. You must either provide a\n`statsPeriod`, or a `start` and `end`.\n" }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "\nThis defines the start of the time series range as an explicit datetime, either in UTC\nISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`.\n" }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "\nThis defines the inclusive end of the time series range as an explicit datetime, either in\nUTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`.\n" }, { "in": "query", "name": "field", "schema": { "type": "array", "items": { "enum": [ "activity", "browser", "count_dead_clicks", "count_errors", "count_rage_clicks", "count_segments", "count_urls", "device", "dist", "duration", "environment", "error_ids", "finished_at", "id", "is_archived", "os", "platform", "project_id", "releases", "sdk", "started_at", "tags", "trace_ids", "urls", "user", "clicks", "info_ids", "warning_ids", "count_warnings", "count_infos", "has_viewed" ], "type": "string", "description": "* `activity`\n* `browser`\n* `count_dead_clicks`\n* `count_errors`\n* `count_rage_clicks`\n* `count_segments`\n* `count_urls`\n* `device`\n* `dist`\n* `duration`\n* `environment`\n* `error_ids`\n* `finished_at`\n* `id`\n* `is_archived`\n* `os`\n* `platform`\n* `project_id`\n* `releases`\n* `sdk`\n* `started_at`\n* `tags`\n* `trace_ids`\n* `urls`\n* `user`\n* `clicks`\n* `info_ids`\n* `warning_ids`\n* `count_warnings`\n* `count_infos`\n* `has_viewed`" } }, "description": "Specifies a field that should be marshaled in the output. Invalid fields will be rejected." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the projects to filter by." }, { "in": "query", "name": "projectSlug", "schema": { "type": "array", "items": { "type": "string" } }, "description": "A list of project slugs to filter your results by." }, { "in": "query", "name": "environment", "schema": { "type": "string", "minLength": 1 }, "description": "The environment to filter by." }, { "in": "query", "name": "sort", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "sortBy", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "orderBy", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "query", "schema": { "type": "string", "minLength": 1 }, "description": "A structured query string to filter the output by." }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "Limit the number of rows to return in the result." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "The cursor parameter is used to paginate results. See [here](https://docs.sentry.io/api/pagination/) for how to use this query parameter" } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "project_id": { "type": "string" }, "trace_ids": { "type": "array", "items": { "type": "string" } }, "error_ids": { "type": "array", "items": { "type": "string" } }, "environment": { "type": "string", "nullable": true }, "tags": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": {} } ] }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "geo": { "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "subdivision": { "type": "string", "nullable": true } } } } }, "sdk": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "os": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "browser": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "device": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "family": { "type": "string", "nullable": true } } }, "ota_updates": { "type": "object", "properties": { "channel": { "type": "string", "nullable": true }, "runtime_version": { "type": "string", "nullable": true }, "update_id": { "type": "string", "nullable": true } } }, "is_archived": { "type": "boolean", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "clicks": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "count_dead_clicks": { "type": "integer", "nullable": true }, "count_rage_clicks": { "type": "integer", "nullable": true }, "count_errors": { "type": "integer", "nullable": true }, "duration": { "type": "integer", "nullable": true }, "finished_at": { "type": "string", "nullable": true }, "started_at": { "type": "string", "nullable": true }, "activity": { "type": "integer", "nullable": true }, "count_urls": { "type": "integer", "nullable": true }, "replay_type": { "type": "string" }, "count_segments": { "type": "integer", "nullable": true }, "platform": { "type": "string", "nullable": true }, "releases": { "type": "array", "items": { "type": "string" } }, "dist": { "type": "string", "nullable": true }, "count_warnings": { "type": "integer", "nullable": true }, "count_infos": { "type": "integer", "nullable": true }, "has_viewed": { "type": "boolean" } } } }, "examples": { "GetListOfReplays": { "value": [ { "activity": 5, "browser": { "name": "Chome", "version": "103.0.38" }, "count_dead_clicks": 6, "count_rage_clicks": 1, "count_errors": 1, "count_segments": 0, "count_urls": 1, "device": { "brand": "Apple", "family": "iPhone", "model": "11", "name": "iPhone 11" }, "dist": null, "duration": 576, "environment": "production", "error_ids": [ "7e07485f-12f9-416b-8b14-26260799b51f" ], "finished_at": "2022-07-07T14:15:33.201019", "has_viewed": true, "id": "7e07485f-12f9-416b-8b14-26260799b51f", "is_archived": null, "os": { "name": "iOS", "version": "16.2" }, "platform": "Sentry", "project_id": "639195", "releases": [ "version@1.4" ], "sdk": { "name": "Thundercat", "version": "27.1" }, "started_at": "2022-07-07T14:05:57.909921", "tags": { "hello": [ "world", "Lionel Richie" ] }, "trace_ids": [ "7e07485f-12f9-416b-8b14-26260799b51f" ], "urls": [ "/organizations/abc123/issues" ], "user": { "display_name": "John Doe", "email": "john.doe@example.com", "id": "30246326", "ip": "213.164.1.114", "username": "John Doe" } } ], "summary": "Get list of replays" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/replays/{replay_id}/": { "get": { "operationId": "Retrieve a Replay Instance", "description": "Return details on an individual replay.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "replay_id", "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the replay you'd like to retrieve.", "required": true }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string", "minLength": 1 }, "description": "\nThis defines the range of the time series, relative to now. The range is given in a\n`` format. For example `1d` for a one day range. Possible units are `m` for\nminutes, `h` for hours, `d` for days and `w` for weeks. You must either provide a\n`statsPeriod`, or a `start` and `end`.\n" }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "\nThis defines the start of the time series range as an explicit datetime, either in UTC\nISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`.\n" }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "\nThis defines the inclusive end of the time series range as an explicit datetime, either in\nUTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`.\n" }, { "in": "query", "name": "field", "schema": { "type": "array", "items": { "enum": [ "activity", "browser", "count_dead_clicks", "count_errors", "count_rage_clicks", "count_segments", "count_urls", "device", "dist", "duration", "environment", "error_ids", "finished_at", "id", "is_archived", "os", "platform", "project_id", "releases", "sdk", "started_at", "tags", "trace_ids", "urls", "user", "clicks", "info_ids", "warning_ids", "count_warnings", "count_infos", "has_viewed" ], "type": "string", "description": "* `activity`\n* `browser`\n* `count_dead_clicks`\n* `count_errors`\n* `count_rage_clicks`\n* `count_segments`\n* `count_urls`\n* `device`\n* `dist`\n* `duration`\n* `environment`\n* `error_ids`\n* `finished_at`\n* `id`\n* `is_archived`\n* `os`\n* `platform`\n* `project_id`\n* `releases`\n* `sdk`\n* `started_at`\n* `tags`\n* `trace_ids`\n* `urls`\n* `user`\n* `clicks`\n* `info_ids`\n* `warning_ids`\n* `count_warnings`\n* `count_infos`\n* `has_viewed`" } }, "description": "Specifies a field that should be marshaled in the output. Invalid fields will be rejected." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the projects to filter by." }, { "in": "query", "name": "projectSlug", "schema": { "type": "array", "items": { "type": "string" } }, "description": "A list of project slugs to filter your results by." }, { "in": "query", "name": "environment", "schema": { "type": "string", "minLength": 1 }, "description": "The environment to filter by." }, { "in": "query", "name": "sort", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "sortBy", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "orderBy", "schema": { "type": "string", "minLength": 1 }, "description": "The field to sort the output by." }, { "in": "query", "name": "query", "schema": { "type": "string", "minLength": 1 }, "description": "A structured query string to filter the output by." }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "Limit the number of rows to return in the result." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "The cursor parameter is used to paginate results. See [here](https://docs.sentry.io/api/pagination/) for how to use this query parameter" } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "project_id": { "type": "string" }, "trace_ids": { "type": "array", "items": { "type": "string" } }, "error_ids": { "type": "array", "items": { "type": "string" } }, "environment": { "type": "string", "nullable": true }, "tags": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": {} } ] }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "geo": { "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "subdivision": { "type": "string", "nullable": true } } } } }, "sdk": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "os": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "browser": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "device": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "family": { "type": "string", "nullable": true } } }, "ota_updates": { "type": "object", "properties": { "channel": { "type": "string", "nullable": true }, "runtime_version": { "type": "string", "nullable": true }, "update_id": { "type": "string", "nullable": true } } }, "is_archived": { "type": "boolean", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "clicks": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "count_dead_clicks": { "type": "integer", "nullable": true }, "count_rage_clicks": { "type": "integer", "nullable": true }, "count_errors": { "type": "integer", "nullable": true }, "duration": { "type": "integer", "nullable": true }, "finished_at": { "type": "string", "nullable": true }, "started_at": { "type": "string", "nullable": true }, "activity": { "type": "integer", "nullable": true }, "count_urls": { "type": "integer", "nullable": true }, "replay_type": { "type": "string" }, "count_segments": { "type": "integer", "nullable": true }, "platform": { "type": "string", "nullable": true }, "releases": { "type": "array", "items": { "type": "string" } }, "dist": { "type": "string", "nullable": true }, "count_warnings": { "type": "integer", "nullable": true }, "count_infos": { "type": "integer", "nullable": true }, "has_viewed": { "type": "boolean" } } }, "examples": { "GetSingleReplayDetails": { "value": { "activity": 5, "browser": { "name": "Chome", "version": "103.0.38" }, "count_dead_clicks": 6, "count_rage_clicks": 1, "count_errors": 1, "count_segments": 0, "count_urls": 1, "device": { "brand": "Apple", "family": "iPhone", "model": "11", "name": "iPhone 11" }, "dist": null, "duration": 576, "environment": "production", "error_ids": [ "7e07485f-12f9-416b-8b14-26260799b51f" ], "finished_at": "2022-07-07T14:15:33.201019", "has_viewed": true, "id": "7e07485f-12f9-416b-8b14-26260799b51f", "is_archived": null, "os": { "name": "iOS", "version": "16.2" }, "platform": "Sentry", "project_id": "639195", "releases": [ "version@1.4" ], "sdk": { "name": "Thundercat", "version": "27.1" }, "started_at": "2022-07-07T14:05:57.909921", "tags": { "hello": [ "world", "Lionel Richie" ] }, "trace_ids": [ "7e07485f-12f9-416b-8b14-26260799b51f" ], "urls": [ "/organizations/abc123/issues" ], "user": { "display_name": "John Doe", "email": "john.doe@example.com", "id": "30246326", "ip": "213.164.1.114", "username": "John Doe" } }, "summary": "Get single replay details" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/repos/{repo_id}/commits/": { "get": { "operationId": "List a Repository's Commits", "description": "List a Repository's Commits", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "repo_id", "schema": { "type": "string" }, "description": "The repository ID.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "pullRequest": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "repository": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "nullable": true }, "provider": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "integrationId": { "type": "string", "nullable": true }, "externalSlug": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "settings": { "type": "object", "properties": { "enabledCodeReview": { "type": "boolean" }, "codeReviewTriggers": { "type": "array", "items": { "type": "string" } } }, "required": [ "codeReviewTriggers", "enabledCodeReview" ], "nullable": true } } }, "author": { "anyOf": [ { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string" } }, "required": [ "email", "name" ] } ] }, "externalUrl": { "type": "string" } }, "required": [ "author", "dateCreated", "externalUrl", "id", "message", "repository", "title" ], "nullable": true }, "suspectCommitType": { "type": "string" }, "repository": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "nullable": true }, "provider": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "integrationId": { "type": "string", "nullable": true }, "externalSlug": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "settings": { "type": "object", "properties": { "enabledCodeReview": { "type": "boolean" }, "codeReviewTriggers": { "type": "array", "items": { "type": "string" } } }, "required": [ "codeReviewTriggers", "enabledCodeReview" ], "nullable": true } } }, "author": { "anyOf": [ { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string" } }, "required": [ "email", "name" ] } ] } }, "required": [ "dateCreated", "id", "message", "pullRequest", "suspectCommitType" ] } }, "examples": { "RepositoryCommits": { "value": [ { "dateCreated": "2018-11-06T21:19:58.536Z", "id": "acbafc639127fd89d10f474520104517ff1d709e", "message": "Initial commit from Create Next App", "suspectCommitType": "", "pullRequest": null } ], "summary": "Repository Commits" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/scim/v2/Groups": { "get": { "operationId": "List an Organization's Paginated Teams", "description": "Returns a paginated list of teams bound to a organization with a SCIM Groups GET Request.\n\nNote that the members field will only contain up to 10,000 members.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "startIndex", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "SCIM 1-offset based index for pagination." }, { "in": "query", "name": "count", "schema": { "type": "integer", "minimum": 0, "default": 100 }, "description": "The maximum number of results the query should return, maximum of 100." }, { "in": "query", "name": "filter", "schema": { "type": "string", "minLength": 1 }, "description": "A SCIM filter expression. The only operator currently supported is `eq`." }, { "in": "query", "name": "excludedAttributes", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Fields that should be left off of return values. Right now the only supported field for this query is members." } ], "tags": [ "SCIM" ], "security": [ { "auth_token": [ "team:admin", "team:read", "team:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "Resources": { "type": "array", "items": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "displayName": { "type": "string" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "display": { "type": "string" } }, "required": [ "display", "value" ] } } }, "required": [ "displayName", "id", "meta", "schemas" ] } } }, "required": [ "Resources", "itemsPerPage", "schemas", "startIndex", "totalResults" ] }, "examples": { "ListAnOrgs'sPaginatedTeams": { "value": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 1, "startIndex": 1, "itemsPerPage": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "23232", "displayName": "test-scimv2", "members": [], "meta": { "resourceType": "Group" } } ] }, "summary": "List an orgs's paginated teams" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Provision a New Team", "description": "Create a new team bound to an organization via a SCIM Groups POST\nRequest. The slug will have a normalization of uppercases/spaces to\nlowercases and dashes.\n\nNote that teams are always created with an empty member set.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "SCIM" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The slug of the team that is shown in the UI." } }, "required": [ "displayName" ] } } }, "required": true }, "security": [ { "auth_token": [ "team:admin", "team:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "displayName": { "type": "string" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "display": { "type": "string" } }, "required": [ "display", "value" ] } } }, "required": [ "displayName", "id", "meta", "schemas" ] }, "examples": { "ProvisionTeam": { "value": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName": "Test SCIMv2", "members": [], "meta": { "resourceType": "Group" }, "id": "123" }, "summary": "provisionTeam" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/scim/v2/Groups/{team_id_or_slug}": { "get": { "operationId": "Query an Individual Team", "description": "Query an individual team with a SCIM Group GET Request.\n- Note that the members field will only contain up to 10000 members.", "parameters": [ { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true }, { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "SCIM" ], "security": [ { "auth_token": [ "team:admin", "team:read", "team:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "displayName": { "type": "string" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "display": { "type": "string" } }, "required": [ "display", "value" ] } } }, "required": [ "displayName", "id", "meta", "schemas" ] }, "examples": { "QueryIndividualTeam": { "value": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "23232", "displayName": "test-scimv2", "members": [], "meta": { "resourceType": "Group" } }, "summary": "Query individual team" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "Update a Team's Attributes", "description": "Update a team's attributes with a SCIM Group PATCH Request.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "SCIM" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string" }, "value": { "type": "object", "additionalProperties": {} }, "path": { "type": "string" } }, "required": [ "op" ] }, "description": "The list of operations to perform. Valid operations are:\n* Renaming a team:\n```json\n{\n \"Operations\": [{\n \"op\": \"replace\",\n \"value\": {\n \"id\": 23,\n \"displayName\": \"newName\"\n }\n }]\n}\n```\n* Adding a member to a team:\n```json\n{\n \"Operations\": [{\n \"op\": \"add\",\n \"path\": \"members\",\n \"value\": [\n {\n \"value\": 23,\n \"display\": \"testexample@example.com\"\n }\n ]\n }]\n}\n```\n* Removing a member from a team:\n```json\n{\n \"Operations\": [{\n \"op\": \"remove\",\n \"path\": \"members[value eq \"23\"]\"\n }]\n}\n```\n* Replacing an entire member set of a team:\n```json\n{\n \"Operations\": [{\n \"op\": \"replace\",\n \"path\": \"members\",\n \"value\": [\n {\n \"value\": 23,\n \"display\": \"testexample2@sentry.io\"\n },\n {\n \"value\": 24,\n \"display\": \"testexample3@sentry.io\"\n }\n ]\n }]\n}\n```\n" } }, "required": [ "Operations" ] } } }, "required": true }, "security": [ { "auth_token": [ "team:admin", "team:write" ] } ], "responses": { "204": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete an Individual Team", "description": "Delete a team with a SCIM Group DELETE Request.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "SCIM" ], "security": [ { "auth_token": [ "team:admin" ] } ], "responses": { "204": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/scim/v2/Users": { "get": { "operationId": "List an Organization's SCIM Members", "description": "Returns a paginated list of members bound to a organization with a SCIM Users GET Request.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "startIndex", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "SCIM 1-offset based index for pagination." }, { "in": "query", "name": "count", "schema": { "type": "integer", "minimum": 0, "default": 100 }, "description": "The maximum number of results the query should return, maximum of 100." }, { "in": "query", "name": "filter", "schema": { "type": "string", "minLength": 1 }, "description": "A SCIM filter expression. The only operator currently supported is `eq`." }, { "in": "query", "name": "excludedAttributes", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Fields that should be left off of return values. Right now the only supported field for this query is members." } ], "tags": [ "SCIM" ], "security": [ { "auth_token": [ "member:admin", "member:read", "member:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "Resources": { "type": "array", "items": { "type": "object", "description": "Conforming to the SCIM RFC, this represents a Sentry Org Member\nas a SCIM user object.", "properties": { "active": { "type": "boolean" }, "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } }, "required": [ "familyName", "givenName" ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "primary": { "type": "boolean" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "primary", "type", "value" ] } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "sentryOrgRole": { "type": "string" } }, "required": [ "emails", "id", "meta", "name", "schemas", "sentryOrgRole", "userName" ] } } }, "required": [ "Resources", "itemsPerPage", "schemas", "startIndex", "totalResults" ] }, "examples": { "ListAnOrganization'sMembers": { "value": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 1, "startIndex": 1, "itemsPerPage": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "102", "userName": "test.user@okta.local", "emails": [ { "primary": true, "value": "test.user@okta.local", "type": "work" } ], "name": { "familyName": "N/A", "givenName": "N/A" }, "active": true, "meta": { "resourceType": "User" }, "sentryOrgRole": "member" } ] }, "summary": "List an Organization's Members" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Provision a New Organization Member", "description": "Create a new Organization Member via a SCIM Users POST Request.\n\nNote that this API does not support setting secondary emails.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "SCIM" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userName": { "type": "string", "format": "email", "description": "The SAML field used for email." }, "sentryOrgRole": { "enum": [ "billing", "member", "manager", "admin" ], "type": "string", "description": "The organization role of the member. If unspecified, this will be\n set to the organization's default role. The options are:\n\n* `billing` - Can manage payment and compliance details.\n* `member` - Can view and act on events, as well as view most other data within the organization.\n* `manager` - Has full management access to all teams and projects. Can also manage\n the organization's membership.\n* `admin` - Can edit global integrations, manage projects, and add/remove teams.\n They automatically assume the Team Admin role for teams they join.\n Note: This role can no longer be assigned in Business and Enterprise plans. Use `TeamRoles` instead.\n " } }, "required": [ "userName" ] } } }, "required": true }, "security": [ { "auth_token": [ "member:admin", "member:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "description": "Conforming to the SCIM RFC, this represents a Sentry Org Member\nas a SCIM user object.", "properties": { "active": { "type": "boolean" }, "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } }, "required": [ "familyName", "givenName" ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "primary": { "type": "boolean" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "primary", "type", "value" ] } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "sentryOrgRole": { "type": "string" } }, "required": [ "emails", "id", "meta", "name", "schemas", "sentryOrgRole", "userName" ] }, "examples": { "ProvisionNewMember": { "value": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "242", "userName": "test.user@okta.local", "emails": [ { "primary": true, "value": "test.user@okta.local", "type": "work" } ], "active": true, "name": { "familyName": "N/A", "givenName": "N/A" }, "meta": { "resourceType": "User" }, "sentryOrgRole": "member" }, "summary": "Provision new member" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/scim/v2/Users/{member_id}": { "get": { "operationId": "Query an Individual Organization Member", "description": "Query an individual organization member with a SCIM User GET Request.\n- The `name` object will contain fields `firstName` and `lastName` with the values of `N/A`.\nSentry's SCIM API does not currently support these fields but returns them for compatibility purposes.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the member to query.", "required": true } ], "tags": [ "SCIM" ], "security": [ { "auth_token": [ "member:admin", "member:read", "member:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Conforming to the SCIM RFC, this represents a Sentry Org Member\nas a SCIM user object.", "properties": { "active": { "type": "boolean" }, "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } }, "required": [ "familyName", "givenName" ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "primary": { "type": "boolean" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "primary", "type", "value" ] } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "sentryOrgRole": { "type": "string" } }, "required": [ "emails", "id", "meta", "name", "schemas", "sentryOrgRole", "userName" ] }, "examples": { "QueryOrgMember": { "value": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "102", "userName": "test.user@okta.local", "emails": [ { "primary": true, "value": "test.user@okta.local", "type": "work" } ], "name": { "familyName": "N/A", "givenName": "N/A" }, "active": true, "meta": { "resourceType": "User" }, "sentryOrgRole": "member" }, "summary": "Query org member" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "patch": { "operationId": "Update an Organization Member's Attributes", "description": "Update an organization member's attributes with a SCIM PATCH Request.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the member to update.", "required": true } ], "tags": [ "SCIM" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string" }, "value": {}, "path": { "type": "string" } }, "required": [ "op", "value" ] }, "description": "A list of operations to perform. Currently, the only valid operation is setting\na member's `active` attribute to false, after which the member will be permanently deleted.\n```json\n{\n \"Operations\": [{\n \"op\": \"replace\",\n \"path\": \"active\",\n \"value\": False\n }]\n}\n```\n", "maxItems": 100 } }, "required": [ "Operations" ] } } }, "required": true }, "security": [ { "auth_token": [ "member:admin", "member:write" ] } ], "responses": { "204": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete an Organization Member via SCIM", "description": "Delete an organization member with a SCIM User DELETE Request.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "member_id", "schema": { "type": "string" }, "description": "The ID of the member to delete.", "required": true } ], "tags": [ "SCIM" ], "security": [ { "auth_token": [ "member:admin" ] } ], "responses": { "204": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/sentry-apps/": { "get": { "operationId": "Retrieve the custom integrations created by an organization", "description": "Retrieve the custom integrations for an organization", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Integration" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "avatars": { "type": "array", "items": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string" }, "avatarUrl": { "type": "string" }, "color": { "type": "boolean" }, "photoType": { "type": "string" } }, "required": [ "avatarType", "avatarUrl", "avatarUuid", "color", "photoType" ] } }, "events": { "type": "array", "items": { "type": "string" } }, "featureData": { "type": "array", "items": { "type": "string" } }, "isAlertable": { "type": "boolean" }, "metadata": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string" }, "status": { "type": "string" }, "uuid": { "type": "string" }, "verifyInstall": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "author": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "popularity": { "type": "integer", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true }, "webhookUrl": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "datePublished": { "type": "string", "format": "date-time" }, "clientId": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ] } }, "required": [ "allowedOrigins", "avatars", "events", "featureData", "isAlertable", "metadata", "name", "schema", "scopes", "slug", "status", "uuid", "verifyInstall" ] } }, "examples": { "RetrieveTheCustomIntegrationsCreatedByTheGivenOrganization": { "value": [ { "allowedOrigins": [], "author": "ACME Corp", "avatars": [ { "avatarType": "avatar", "avatarUuid": "6c25b771-a576-4c18-a1c3-ab059c1d42ba", "avatarUrl": "https://example.com/avatar.png", "color": false, "photoType": "icon" } ], "events": [ "issue" ], "isAlertable": false, "isDisabled": false, "metadata": "", "name": "ACME Corp Integration", "overview": null, "popularity": 27, "redirectUrl": null, "featureData": [], "schema": "", "scopes": [ "event:read", "org:read" ], "slug": "acme-corp-integration", "status": "unpublished", "uuid": "77cebea3-019e-484d-8673-6c3969698827", "verifyInstall": true, "webhookUrl": "https://example.com/webhook", "clientId": "ed06141686bb60102d878c607eff449fa9907fa7a8cb70f0d337a8fb0b6566c3", "clientSecret": "**********", "owner": { "id": 42, "slug": "acme-corp" } }, { "allowedOrigins": [], "author": "ACME Corp", "avatars": [], "events": [ "issue", "event" ], "isAlertable": false, "isDisabled": false, "metadata": "", "name": "ACME Corp Integration v2", "overview": null, "popularity": 0, "redirectUrl": "example.com", "featureData": [], "schema": "", "scopes": [ "event:admin", "org:admin" ], "slug": "acme-corp-integration-v2", "status": "unpublished", "uuid": "77cebea3-019e-484d-8673-123124234", "verifyInstall": true, "webhookUrl": "https://example.com/webhook", "clientId": "2730a92919437a7b052e6827cd2c9f119be37101asdasdad123131231231231", "clientSecret": "**********", "owner": { "id": 42, "slug": "acme-corp" } } ], "summary": "Retrieve the custom integrations created by the given organization" } } } }, "description": "" } } } }, "/api/0/organizations/{organization_id_or_slug}/sessions/": { "get": { "operationId": "Retrieve Release Health Session Statistics", "description": "Returns a time series of release health session statistics for projects bound to an organization.\n\nThe interval and date range are subject to certain restrictions and rounding rules.\n\nThe date range is rounded to align with the interval, and is rounded to at least one\nhour. The interval can at most be one day and at least one hour currently. It has to cleanly\ndivide one day, for rounding reasons.\n\nBecause of technical limitations, this endpoint returns\nat most 10000 data points. For example, if you select a 90 day window grouped by releases,\nyou will see at most `floor(10k / (90 + 1)) = 109` releases. To get more results, reduce the\n`statsPeriod`.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "field", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The list of fields to query.\n\nThe available fields are\n- `sum(session)`\n- `count_unique(user)`\n- `avg`, `p50`, `p75`, `p90`, `p95`, `p99`, `max` applied to `session.duration`. For example, `p99(session.duration)`. Session duration is [no longer being recorded](https://github.com/getsentry/sentry/discussions/42716) as of on Jan 12, 2023. Returned data may be incomplete.\n- `crash_rate`, `crash_free_rate` applied to `user` or `session`. For example, `crash_free_rate(user)`\n", "required": true }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string" }, "description": "The period of time for the query, will override the start & end parameters, a number followed by one of:\n- `d` for days\n- `h` for hours\n- `m` for minutes\n- `s` for seconds\n- `w` for weeks\n\nFor example, `24h`, to mean query data starting from 24 hours ago to now." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "The number of groups to return per request." }, { "in": "query", "name": "interval", "schema": { "type": "string" }, "description": "Resolution of the time series, given in the same format as `statsPeriod`.\n\nThe default and\n the minimum interval is `1h`." }, { "in": "query", "name": "groupBy", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The list of properties to group by.\n\nThe available groupBy conditions are `project`,\n `release`, `environment` and `session.status`." }, { "in": "query", "name": "orderBy", "schema": { "type": "string" }, "description": "An optional field to order by, which must be one of the fields provided in `field`. Use `-`\n for descending order, for example, `-sum(session)`" }, { "in": "query", "name": "includeTotals", "schema": { "type": "integer" }, "description": "Specify `0` to exclude totals from the response. The default is `1`" }, { "in": "query", "name": "includeSeries", "schema": { "type": "integer" }, "description": "Specify `0` to exclude series from the response. The default is `1`" }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Filters results by using [query syntax](/product/sentry-basics/search/).\n\nExample: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`\n" } ], "tags": [ "Releases" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "intervals": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "by": { "type": "object", "properties": { "project": { "type": "integer" }, "release": { "type": "string" }, "environment": { "type": "string" }, "session.status": { "type": "string" } } }, "series": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "number", "format": "double", "nullable": true } } }, "totals": { "type": "object", "additionalProperties": { "type": "number", "format": "double", "nullable": true } } }, "required": [ "by", "series", "totals" ] } }, "query": { "type": "string" } }, "required": [ "end", "groups", "intervals", "query", "start" ] }, "examples": { "QuerySessions": { "value": { "groups": [ { "by": { "session.status": "errored" }, "totals": { "sum(session)": 1000 }, "series": { "sum(session)": [ 368, 392, 240 ] } }, { "by": { "session.status": "healthy" }, "totals": { "sum(session)": 17905998 }, "series": { "sum(session)": [ 6230841, 6923689, 4751465 ] } } ], "start": "2024-01-29T07:30:00Z", "end": "2024-01-29T09:00:00Z", "intervals": [ "2024-01-29T07:30:00Z", "2024-01-29T08:00:00Z", "2024-01-29T08:30:00Z" ], "query": "" }, "summary": "Query Sessions" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } } } }, "/api/0/organizations/{organization_id_or_slug}/shortids/{issue_id}/": { "get": { "operationId": "Resolve a Short ID", "description": "Resolve a short ID to the project slug and group details.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "issue_id", "schema": { "type": "string" }, "description": "The short ID of the issue to resolve.", "required": true }, { "in": "query", "name": "collapse", "schema": { "type": "array", "items": { "type": "string", "enum": [ "base", "filtered", "lifetime", "stats", "unhandled" ] } }, "description": "Fields to remove from the response to improve query performance." } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationSlug": { "type": "string" }, "projectSlug": { "type": "string" }, "groupId": { "type": "string" }, "group": { "type": "object", "properties": { "isUnhandled": { "type": "boolean" }, "count": { "type": "string" }, "userCount": { "type": "integer" }, "firstSeen": { "type": "string", "format": "date-time", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string" }, "shareId": { "type": "string" }, "shortId": { "type": "string" }, "title": { "type": "string" }, "culprit": { "type": "string", "nullable": true }, "permalink": { "type": "string" }, "logger": { "type": "string", "nullable": true }, "level": { "type": "string" }, "status": { "type": "string" }, "statusDetails": { "type": "object", "properties": { "autoResolved": { "type": "boolean" }, "ignoreCount": { "type": "integer" }, "ignoreUntil": { "type": "string", "format": "date-time" }, "ignoreUserCount": { "type": "integer" }, "ignoreUserWindow": { "type": "integer" }, "ignoreWindow": { "type": "integer" }, "actor": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "inNextRelease": { "type": "boolean" }, "inRelease": { "type": "string" }, "inCommit": { "type": "string" }, "pendingEvents": { "type": "integer" }, "info": {} } }, "substatus": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" }, "platform": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "priorityLockedAt": { "type": "string", "format": "date-time", "nullable": true }, "seerFixabilityScore": { "type": "number", "format": "double", "nullable": true }, "seerAutofixLastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "seerExplorerAutofixLastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "name", "platform", "slug" ] }, "type": { "type": "string" }, "issueType": { "type": "string" }, "issueCategory": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} }, "numComments": { "type": "integer" }, "assignedTo": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] }, "isBookmarked": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "subscriptionDetails": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "reason": { "type": "string" } }, "nullable": true }, "hasSeen": { "type": "boolean" }, "annotations": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string" }, "url": { "type": "string" } }, "required": [ "displayName", "url" ] } } }, "required": [ "annotations", "assignedTo", "culprit", "hasSeen", "id", "isBookmarked", "isPublic", "isSubscribed", "issueCategory", "issueType", "level", "logger", "metadata", "numComments", "permalink", "platform", "priority", "priorityLockedAt", "project", "seerAutofixLastTriggered", "seerExplorerAutofixLastTriggered", "seerFixabilityScore", "shareId", "shortId", "status", "statusDetails", "subscriptionDetails", "substatus", "title", "type" ] }, "shortId": { "type": "string" } }, "required": [ "group", "groupId", "organizationSlug", "projectSlug", "shortId" ] }, "examples": { "ShortIDLookup": { "value": { "group": { "annotations": [], "assignedTo": { "id": "1", "name": "John Doe", "email": "john@example.com", "type": "user" }, "count": "1", "culprit": "raven.scripts.runner in main", "firstSeen": "2018-11-06T21:19:55Z", "hasSeen": false, "id": "1", "isBookmarked": false, "isPublic": false, "isSubscribed": true, "lastSeen": "2018-11-06T21:19:55Z", "level": "error", "logger": null, "metadata": { "title": "This is an example Python exception" }, "numComments": 0, "permalink": "https://sentry.io/the-interstellar-jurisdiction/pump-station/issues/1/", "project": { "id": "2", "name": "Pump Station", "slug": "pump-station", "platform": "python" }, "shareId": "abc123", "shortId": "PUMP-STATION-1", "status": "unresolved", "statusDetails": {}, "subscriptionDetails": null, "title": "This is an example Python exception", "type": "default", "userCount": 0, "issueCategory": "error", "issueType": "error", "platform": "python", "priority": "medium", "priorityLockedAt": null, "seerFixabilityScore": 0.5, "seerAutofixLastTriggered": null, "seerExplorerAutofixLastTriggered": null, "substatus": "ongoing" }, "groupId": "1", "organizationSlug": "the-interstellar-jurisdiction", "projectSlug": "pump-station", "shortId": "PUMP-STATION-1" }, "summary": "Short ID Lookup" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/stats-summary/": { "get": { "operationId": "Retrieve an Organization's Events Count by Project", "description": "Query summarized event counts by project for your Organization. Also see https://docs.sentry.io/api/organizations/retrieve-event-counts-for-an-organization-v2/ for reference.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "field", "schema": { "enum": [ "sum(quantity)", "sum(times_seen)" ], "type": "string", "minLength": 1 }, "description": "the `sum(quantity)` field is bytes for attachments, and all others the 'event' count for those types of events.\n\n`sum(times_seen)` sums the number of times an event has been seen. For 'normal' event types, this will be equal to `sum(quantity)` for now. For sessions, quantity will sum the total number of events seen in a session, while `times_seen` will be the unique number of sessions. and for attachments, `times_seen` will be the total number of attachments, while quantity will be the total sum of attachment bytes.\n\n* `sum(quantity)`\n* `sum(times_seen)`", "required": true }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string", "minLength": 1 }, "description": "This defines the range of the time series, relative to now. The range is given in a `` format. For example `1d` for a one day range. Possible units are `m` for minutes, `h` for hours, `d` for days and `w` for weeks. You must either provide a `statsPeriod`, or a `start` and `end`." }, { "in": "query", "name": "interval", "schema": { "type": "string", "minLength": 1 }, "description": "This is the resolution of the time series, given in the same format as `statsPeriod`. The default resolution is `1h` and the minimum resolution is currently restricted to `1h` as well. Intervals larger than `1d` are not supported, and the interval has to cleanly divide one day." }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`." }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": {} }, "description": "The ID of the projects to filter by." }, { "in": "query", "name": "category", "schema": { "enum": [ "error", "transaction", "attachment", "replays", "profiles" ], "type": "string", "minLength": 1 }, "description": "If filtering by attachments, you cannot filter by any other category due to quantity values becoming nonsensical (combining bytes and event counts).\n\nIf filtering by `error`, it will automatically add `default` and `security` as we currently roll those two categories into `error` for displaying.\n\n* `error`\n* `transaction`\n* `attachment`\n* `replays`\n* `profiles`" }, { "in": "query", "name": "outcome", "schema": { "enum": [ "accepted", "filtered", "rate_limited", "invalid", "abuse", "client_discard", "cardinality_limited" ], "type": "string", "minLength": 1 }, "description": "See https://docs.sentry.io/product/stats/ for more information on outcome statuses.\n\n* `accepted`\n* `filtered`\n* `rate_limited`\n* `invalid`\n* `abuse`\n* `client_discard`\n* `cardinality_limited`" }, { "in": "query", "name": "reason", "schema": { "type": "string", "minLength": 1 }, "description": "The reason field will contain why an event was filtered/dropped." }, { "in": "query", "name": "download", "schema": { "type": "boolean" }, "description": "Download the API response in as a csv file" } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "stats": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "id", "slug", "stats" ] } } }, "required": [ "end", "projects", "start" ] }, "examples": { "GetEventCountsForProjectsInAnOrganization": { "value": { "start": "2023-09-19T13:00:00Z", "end": "2023-09-19T12:28:00Z", "projects": [ { "id": "1", "slug": "android-project", "stats": [ { "category": "error", "outcomes": { "accepted": 1930571, "filtered": 1934881, "rate_limited": 2506132, "invalid": 0, "abuse": 1938113, "client_discard": 1942414, "cardinality_limited": 0 }, "totals": { "dropped": 2506132, "sum(quantity)": 10252111 } }, { "category": "transaction", "outcomes": { "accepted": 1909849, "filtered": 1947142, "rate_limited": 2458946, "invalid": 0, "abuse": 1927179, "client_discard": 1931595, "cardinality_limited": 0 }, "totals": { "dropped": 2458946, "sum(quantity)": 10174711 } } ] } ] }, "summary": "Get event counts for projects in an organization" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/stats_v2/": { "get": { "operationId": "Retrieve Event Counts for an Organization (v2)", "description": "Query event counts for your Organization.\nSelect a field, define a date range, and group or filter by columns.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "groupBy", "schema": { "type": "array", "items": { "enum": [ "outcome", "category", "reason", "project" ], "type": "string", "description": "* `outcome`\n* `category`\n* `reason`\n* `project`" } }, "description": "can pass multiple groupBy parameters to group by multiple, e.g. `groupBy=project&groupBy=outcome` to group by multiple dimensions. Note that grouping by project can cause missing rows if the number of projects / interval is large. If you have a large number of projects, we recommend filtering and querying by them individually.Also note that grouping by projects does not currently support timeseries interval responses and will instead be a sum of the projectover the entire period specified.", "required": true }, { "in": "query", "name": "field", "schema": { "enum": [ "sum(quantity)", "sum(times_seen)" ], "type": "string", "minLength": 1 }, "description": "the `sum(quantity)` field is bytes for attachments, and all others the 'event' count for those types of events.\n\n`sum(times_seen)` sums the number of times an event has been seen. For 'normal' event types, this will be equal to `sum(quantity)` for now. For sessions, quantity will sum the total number of events seen in a session, while `times_seen` will be the unique number of sessions. and for attachments, `times_seen` will be the total number of attachments, while quantity will be the total sum of attachment bytes.\n\n* `sum(quantity)`\n* `sum(times_seen)`", "required": true }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string", "minLength": 1 }, "description": "This defines the range of the time series, relative to now. The range is given in a `` format. For example `1d` for a one day range. Possible units are `m` for minutes, `h` for hours, `d` for days and `w` for weeks. You must either provide a `statsPeriod`, or a `start` and `end`." }, { "in": "query", "name": "interval", "schema": { "type": "string", "minLength": 1 }, "description": "This is the resolution of the time series, given in the same format as `statsPeriod`. The default resolution is `1h` and the minimum resolution is currently restricted to `1h` as well. Intervals larger than `1d` are not supported, and the interval has to cleanly divide one day." }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`." }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": {} }, "description": "The ID of the projects to filter by.\n\nUse `-1` to include all accessible projects." }, { "in": "query", "name": "category", "schema": { "enum": [ "error", "transaction", "attachment", "replay", "profile", "profile_duration", "profile_duration_ui", "profile_chunk", "profile_chunk_ui", "monitor" ], "type": "string", "minLength": 1 }, "description": "Filter by data category. Each category represents a different type of data:\n\n- `error`: Error events (includes `default` and `security` categories)\n- `transaction`: Transaction events\n- `attachment`: File attachments (note: cannot be combined with other categories since quantity represents bytes)\n- `replay`: Session replay events\n- `profile`: Performance profiles\n- `profile_duration`: Profile duration data (note: cannot be combined with other categories since quantity represents milliseconds)\n- `profile_duration_ui`: Profile duration (UI) data (note: cannot be combined with other categories since quantity represents milliseconds)\n- `profile_chunk`: Profile chunk data\n- `profile_chunk_ui`: Profile chunk (UI) data\n- `monitor`: Cron monitor events\n\n* `error`\n* `transaction`\n* `attachment`\n* `replay`\n* `profile`\n* `profile_duration`\n* `profile_duration_ui`\n* `profile_chunk`\n* `profile_chunk_ui`\n* `monitor`" }, { "in": "query", "name": "outcome", "schema": { "enum": [ "accepted", "filtered", "rate_limited", "invalid", "abuse", "client_discard", "cardinality_limited" ], "type": "string", "minLength": 1 }, "description": "See https://docs.sentry.io/product/stats/ for more information on outcome statuses.\n\n* `accepted`\n* `filtered`\n* `rate_limited`\n* `invalid`\n* `abuse`\n* `client_discard`\n* `cardinality_limited`" }, { "in": "query", "name": "reason", "schema": { "type": "string", "minLength": 1 }, "description": "The reason field will contain why an event was filtered/dropped." } ], "tags": [ "Organizations" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "intervals": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "by": { "type": "object", "additionalProperties": {} }, "totals": { "type": "object", "additionalProperties": {} }, "series": { "type": "object", "additionalProperties": {} } }, "required": [ "by", "series", "totals" ] } } }, "required": [ "end", "groups", "intervals", "start" ] }, "examples": { "RetrieveEventCountsV2": { "value": { "start": "2022-02-14T19:00:00Z", "end": "2022-02-28T18:03:00Z", "intervals": [ "2022-02-28T00:00:00Z" ], "groups": [ { "by": { "outcome": "invalid" }, "totals": { "sum(quantity)": 165665 }, "series": { "sum(quantity)": [ 165665 ] } } ] }, "summary": "Retrieve event counts v2" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/teams/": { "get": { "operationId": "List an Organization's Teams", "description": "Returns a list of teams bound to a organization.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "detailed", "schema": { "type": "string" }, "description": "\nSpecify `\"0\"` to return team details that do not include projects.\n" }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] } }, "examples": { "GetListOfOrganization'sTeams": { "value": [ { "id": "48531", "slug": "ancient-gabelers", "name": "Ancient Gabelers", "dateCreated": "2018-11-06T21:20:08.115Z", "isMember": false, "teamRole": null, "flags": { "idp:provisioned": false }, "access": [ "member:read", "alerts:read", "org:read", "event:read", "project:read", "project:releases", "event:write", "team:read" ], "hasAccess": true, "isPending": false, "memberCount": 2, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null } }, { "id": "100253", "slug": "powerful-abolitionist", "name": "Powerful Abolitionist", "dateCreated": "2018-10-03T17:47:50.745447Z", "isMember": false, "teamRole": null, "flags": { "idp:provisioned": false }, "access": [ "member:read", "alerts:read", "org:read", "event:read", "project:read", "project:releases", "event:write", "team:read" ], "hasAccess": true, "isPending": false, "memberCount": 5, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "projects": [ { "id": "6403534", "slug": "prime-mover", "name": "Prime Mover", "platform": null, "dateCreated": "2019-04-06T00:02:40.468175Z", "isBookmarked": false, "isMember": false, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2", "releases" ], "firstEvent": "2019-04-06T02:00:21Z", "firstTransactionEvent": true, "access": [ "alerts:read", "event:write", "org:read", "project:read", "member:read", "team:read", "event:read", "project:releases" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasMonitors": true, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasFeedbacks": false, "hasNewFeedbacks": false, "hasSessions": true, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#6d3fbf", "status": "active" }, { "id": "6403599", "slug": "the-spoiled-yoghurt", "name": "The Spoiled Yoghurt", "platform": "", "dateCreated": "2022-06-24T17:55:27.304367Z", "isBookmarked": false, "isMember": false, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": "2022-07-13T18:17:56.197351Z", "firstTransactionEvent": false, "access": [ "alerts:read", "event:write", "org:read", "project:read", "member:read", "team:read", "event:read", "project:releases" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasMonitors": true, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasFeedbacks": false, "hasNewFeedbacks": false, "hasSessions": false, "hasInsightsHttp": false, "hasInsightsDb": true, "hasInsightsAssets": true, "hasInsightsAppStart": true, "hasInsightsScreenLoad": true, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#6e3fbf", "status": "active" } ] } ], "summary": "Get list of organization's teams" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Create a New Team", "description": "Create a new team bound to an organization. Requires at least one of the `name`\nor `slug` body params to be set.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Teams" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "nullable": true, "description": "Uniquely identifies a team and is used for the interface. If not\n provided, it is automatically generated from the name.", "maxLength": 50, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "name": { "type": "string", "nullable": true, "description": "**`[DEPRECATED]`** The name for the team. If not provided, it is\n automatically generated from the slug", "maxLength": 64, "deprecated": true } } } } } }, "security": [ { "auth_token": [ "org:admin", "org:write", "team:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] }, "examples": { "CreateANewTeam": { "value": { "id": "5151492858", "slug": "ancient-gabelers", "name": "Ancient Gabelers", "dateCreated": "2021-06-12T23:38:54.168307Z", "isMember": true, "teamRole": "admin", "flags": { "idp:provisioned": false }, "access": [ "project:write", "member:read", "event:write", "team:admin", "alerts:read", "project:releases", "alerts:write", "org:read", "team:read", "project:admin", "project:read", "org:integrations", "event:read", "event:admin", "team:write" ], "hasAccess": true, "isPending": false, "memberCount": 1, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null } }, "summary": "Create a new team" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "A team with this slug already exists." } } } }, "/api/0/organizations/{organization_id_or_slug}/user-teams/": { "get": { "operationId": "List a User's Teams for an Organization", "description": "Returns a list of teams the user has access to in the specified organization.\nNote that this endpoint is restricted to [user auth tokens](https://docs.sentry.io/account/auth-tokens/#user-auth-tokens).", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] } }, "examples": { "GetListOfOrganization'sTeams": { "value": [ { "id": "48531", "slug": "ancient-gabelers", "name": "Ancient Gabelers", "dateCreated": "2018-11-06T21:20:08.115Z", "isMember": false, "teamRole": null, "flags": { "idp:provisioned": false }, "access": [ "member:read", "alerts:read", "org:read", "event:read", "project:read", "project:releases", "event:write", "team:read" ], "hasAccess": true, "isPending": false, "memberCount": 2, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null } }, { "id": "100253", "slug": "powerful-abolitionist", "name": "Powerful Abolitionist", "dateCreated": "2018-10-03T17:47:50.745447Z", "isMember": false, "teamRole": null, "flags": { "idp:provisioned": false }, "access": [ "member:read", "alerts:read", "org:read", "event:read", "project:read", "project:releases", "event:write", "team:read" ], "hasAccess": true, "isPending": false, "memberCount": 5, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "projects": [ { "id": "6403534", "slug": "prime-mover", "name": "Prime Mover", "platform": null, "dateCreated": "2019-04-06T00:02:40.468175Z", "isBookmarked": false, "isMember": false, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2", "releases" ], "firstEvent": "2019-04-06T02:00:21Z", "firstTransactionEvent": true, "access": [ "alerts:read", "event:write", "org:read", "project:read", "member:read", "team:read", "event:read", "project:releases" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasMonitors": true, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasFeedbacks": false, "hasNewFeedbacks": false, "hasSessions": true, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#6d3fbf", "status": "active" }, { "id": "6403599", "slug": "the-spoiled-yoghurt", "name": "The Spoiled Yoghurt", "platform": "", "dateCreated": "2022-06-24T17:55:27.304367Z", "isBookmarked": false, "isMember": false, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": "2022-07-13T18:17:56.197351Z", "firstTransactionEvent": false, "access": [ "alerts:read", "event:write", "org:read", "project:read", "member:read", "team:read", "event:read", "project:releases" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasMonitors": true, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasFeedbacks": false, "hasNewFeedbacks": false, "hasSessions": false, "hasInsightsHttp": false, "hasInsightsDb": true, "hasInsightsAssets": true, "hasInsightsAppStart": true, "hasInsightsScreenLoad": true, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#6e3fbf", "status": "active" } ] } ], "summary": "Get list of organization's teams" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/organizations/{organization_id_or_slug}/workflows/": { "get": { "operationId": "Fetch Alerts", "description": "Returns a list of alerts for a given organization", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "sortBy", "schema": { "type": "string" }, "description": "The field to sort results by. If not specified, the results are sorted by id.\n\nAvailable fields are:\n- `name`\n- `id`\n- `dateCreated`\n- `dateUpdated`\n- `connectedDetectors`\n- `actions`\n- `priorityDetector`\n\nPrefix with `-` to sort in descending order.\n " }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "An optional search query for filtering alerts." }, { "in": "query", "name": "id", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the alert you'd like to query." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" } ], "tags": [ "Monitors" ], "security": [ { "auth_token": [ "alerts:read", "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "triggers": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } }, "nullable": true }, "actionFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } } }, "nullable": true }, "environment": { "type": "string", "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "detectorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" }, "lastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "string", "nullable": true } }, "required": [ "actionFilters", "config", "createdBy", "dateCreated", "dateUpdated", "detectorIds", "enabled", "environment", "id", "lastTriggered", "name", "organizationId", "owner", "triggers" ] } }, "examples": { "ListAllWorkflowsInAnOrganization": { "value": [ { "id": "123", "name": "Send a notification for high priority issues", "organizationId": "1", "createdBy": null, "dateCreated": "2025-03-18T20:48:55.495059Z", "dateUpdated": "2025-03-18T20:48:55.579094Z", "triggers": { "id": "12345", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "2345", "type": "new_high_priority_issue", "comparison": true, "conditionResult": true }, { "id": "3456", "type": "existing_high_priority_issue", "comparison": true, "conditionResult": true } ], "actions": [] }, "actionFilters": [ { "id": "5678", "organizationId": "1", "logicType": "all", "conditions": [], "actions": [ { "id": "234", "type": "email", "integrationId": null, "data": { "fallthroughType": "ActiveMembers" }, "config": { "targetType": "issue_owners", "targetDisplay": null, "targetIdentifier": null }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 30 }, "detectorIds": [], "enabled": true, "lastTriggered": null, "owner": "user:123456" }, { "id": "456", "name": "Notify team #example-team", "organizationId": "1", "createdBy": "34567", "dateCreated": "2026-01-15T23:46:39.594915Z", "dateUpdated": "2026-01-15T23:46:39.594903Z", "triggers": { "id": "12345", "organizationId": "1", "logicType": "any-short", "conditions": [], "actions": [] }, "actionFilters": [ { "id": "6789", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "5678", "type": "event_frequency_count", "comparison": { "value": 100, "interval": "1h" }, "conditionResult": true } ], "actions": [ { "id": "1234", "type": "email", "integrationId": null, "data": {}, "config": { "targetType": "team", "targetDisplay": null, "targetIdentifier": "1234567890" }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 1440 }, "detectorIds": [], "enabled": true, "lastTriggered": null, "owner": "team:456789" }, { "id": "789", "name": "Notify Jane Doe", "organizationId": "1", "createdBy": "2345", "dateCreated": "2026-01-15T23:46:39.594915Z", "dateUpdated": "2026-01-15T23:49:57.697583Z", "triggers": { "id": "56789", "organizationId": "1", "logicType": "any-short", "conditions": [], "actions": [] }, "actionFilters": [ { "id": "56789", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "234567", "type": "event_unique_user_frequency_count", "comparison": { "value": 100, "filters": [ { "key": "foo", "match": "eq", "value": "bar" } ], "interval": "1h" }, "conditionResult": true } ], "actions": [ { "id": "456789", "type": "email", "integrationId": null, "data": {}, "config": { "targetType": "user", "targetDisplay": null, "targetIdentifier": "123456" }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 1440 }, "detectorIds": [], "enabled": true, "lastTriggered": null, "owner": null } ], "summary": "List all workflows in an organization" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Create an Alert for an Organization", "description": "Creates an alert for an organization", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true } ], "tags": [ "Monitors" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "name": { "type": "string", "description": "The name of the alert", "maxLength": 256 }, "id": { "type": "string", "description": "The ID of the existing alert" }, "enabled": { "type": "boolean", "default": true, "description": "Whether the alert is enabled or disabled" }, "detector_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the monitors to connect this alert to. Use 'Fetch an Organization's Monitors' to find the IDs." }, "config": { "type": "object", "additionalProperties": {}, "description": "\n Typically the frequency at which the alert will fire, in minutes.\n\n - `0`: 0 minutes\n - `5`: 5 minutes\n - `10`: 10 minutes\n - `30`: 30 minutes\n - `60`: 1 hour\n - `180`: 3 hours\n - `720`: 12 hours\n - `1440`: 24 hours\n\n ```json\n {\n \"frequency\":3600\n }\n ```\n " }, "environment": { "type": "string", "nullable": true, "description": "The name of the environment for the alert to evaluate in" }, "triggers": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "logic_type": { "enum": [ "any", "any-short", "all", "none" ], "type": "string", "description": "* `any`\n* `any-short`\n* `all`\n* `none`" }, "conditions": { "type": "array", "items": {} } }, "required": [ "logic_type" ] } ], "description": "The conditions on which the alert will trigger. See available options below.\n ```json\n \"triggers\": {\n \"organizationId\": \"1\",\n \"logicType\": \"any-short\",\n \"conditions\": [\n {\n \"type\": \"first_seen_event\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"issue_resolved_trigger\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"reappeared_event\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"regression_event\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ],\n \"actions\": []\n }\n ```\n " }, "action_filters": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "The filters to run before the action will fire and the action(s) to fire.\n\n `logicType` can be one of `any-short`, `all`, or `none`.\n\n Below is a basic example. See below for all other options.\n\n ```json\n \"actionFilters\": [\n {\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"level\",\n \"comparison\": {\n \"level\": 50,\n \"match\": \"eq\"\n },\n \"conditionResult\": true\n }\n ],\n \"actions\": [\n {\n \"id\": \"123\",\n \"type\": \"email\",\n \"integrationId\": null,\n \"data\": {},\n \"config\": {\n \"targetType\": \"user\",\n \"targetDisplay\": null,\n \"targetIdentifier\": \"56789\"\n },\n \"status\": \"active\"\n }\n ]\n }\n ]\n ```\n\n ## Conditions\n\n **Issue Age**\n - `time`: One of `minute`, `hour`, `day`, or `week`.\n - `value`: A positive integer.\n - `comparisonType`: One of `older` or `newer`.\n ```json\n {\n \"type\": \"age_comparison\",\n \"comparison\": {\n \"time\": \"minute\",\n \"value\": 10,\n \"comparisonType\": \"older\"\n },\n \"conditionResult\": true\n }\n\n ```\n\n **Issue Assignment**\n - `targetType`: Who the issue is assigned to\n - `Unassigned`: Unassigned\n - `Member`: Assigned to a user\n - `Team`: Assigned to a team\n - `targetIdentifier`: The ID of the user or team from the `targetType`. Enter \"\" if `targetType` is `Unassigned`.\n ```json\n {\n \"type\": \"assigned_to\",\n \"comparison\": {\n \"targetType\": \"Member\",\n \"targetIdentifier\": 123456\n },\n \"conditionResult\": true\n }\n ```\n\n **Issue Category**\n - `value`: The issue category to filter to.\n - `1`: Error issues\n - `6`: Feedback issues\n - `10`: Outage issues\n - `11`: Metric issues\n - `12`: DB Query issues\n - `13`: HTTP Client issues\n - `14`: Front end issues\n - `15`: Mobile issues\n ```json\n {\n \"type\": \"issue_category\",\n \"comparison\": {\n \"value\": 1\n },\n \"conditionResult\": true\n }\n ```\n\n **Issue Frequency**\n - `value`: A positive integer representing how many times the issue has to happen before the alert will fire.\n ```json\n {\n \"type\": \"issue_occurrences\",\n \"comparison\": {\n \"value\": 10\n },\n \"conditionResult\": true\n }\n ```\n\n **De-escalation**\n ```json\n {\n \"type\": \"issue_priority_deescalating\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ```\n\n **Issue Priority**\n - `comparison`: The priority the issue must be for the alert to fire.\n - `75`: High priority\n - `50`: Medium priority\n - `25`: Low priority\n ```json\n {\n \"type\": \"issue_priority_greater_or_equal\",\n \"comparison\": 75,\n \"conditionResult\": true\n }\n ```\n\n **Number of Users Affected**\n - `value`: A positive integer representing the number of users that must be affected before the alert will fire.\n - `filters`: A list of additional sub-filters to evaluate before the alert will fire.\n - `interval`: The time period in which to evaluate the value. e.g. Number of users affected by an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"event_unique_user_frequency_count\",\n \"comparison\": {\n \"value\": 100,\n \"filters\": [{\"key\": \"foo\", \"match\": \"eq\", \"value\": \"bar\"}],\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Number of Events**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"event_frequency_count\",\n \"comparison\": {\n \"value\": 100,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Percent of Events**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is `comparisonInterval` percent higher `value` compared to `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n - `comparisonInterval`: The time period to compare against. See `interval` for options.\n ```json\n {\n \"type\": \"event_frequency_percent\",\n \"comparison\": {\n \"value\": 100,\n \"interval\": \"1h\",\n \"comparisonInterval\": \"1w\"\n },\n \"conditionResult\": true\n }\n\n ```\n\n **Percentage of Sessions Affected Count**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"percent_sessions_count\",\n \"comparison\": {\n \"value\": 10,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Percentage of Sessions Affected Percent**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is `comparisonInterval` percent higher `value` compared to `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n - `comparisonInterval`: The time period to compare against. See `interval` for options.\n ```json\n {\n \"type\": \"percent_sessions_percent\",\n \"comparison\": {\n \"value\": 10,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Event Attribute**\n The event's `attribute` value `match` `value`\n\n - `attribute`: The event attribute to match on. Valid values are: `message`, `platform`, `environment`, `type`, `error.handled`, `error.unhandled`, `error.main_thread`, `exception.type`, `exception.value`, `user.id`, `user.email`, `user.username`, `user.ip_address`, `http.method`, `http.url`, `http.status_code`, `sdk.name`, `stacktrace.code`, `stacktrace.module`, `stacktrace.filename`, `stacktrace.abs_path`, `stacktrace.package`, `unreal.crash_type`, `app.in_foreground`.\n - `match`: The comparison operator\n - `co`: Contains\n - `nc`: Does not contain\n - `eq`: Equals\n - `ne`: Does not equal\n - `sw`: Starts with\n - `ew`: Ends with\n - `is`: Is set\n - `ns`: Is not set\n - `value`: A string. Not required when match is `is` or `ns`.\n\n ```json\n {\n \"type\": \"event_attribute\",\n \"comparison\": {\n \"match\": \"co\",\n \"value\": \"bar\",\n \"attribute\": \"message\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Tagged Event**\n The event's tags `key` match `value`\n - `key`: The tag value\n - `match`: The comparison operator\n - `co`: Contains\n - `nc`: Does not contain\n - `eq`: Equals\n - `ne`: Does not equal\n - `sw`: Starts with\n - `ew`: Ends with\n - `is`: Is set\n - `ns`: Is not set\n - `value`: A string. Not required when match is `is` or `ns`.\n\n ```json\n {\n \"type\": \"tagged_event\",\n \"comparison\": {\n \"key\": \"level\",\n \"match\": \"eq\",\n \"value\": \"error\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Latest Release**\n The event is from the latest release\n\n ```json\n {\n \"type\": \"latest_release\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ```\n\n **Release Age**\n ```json\n {\n \"type\": \"latest_adopted_release\",\n \"comparison\": {\n \"environment\": \"12345\",\n \"ageComparison\": \"older\",\n \"releaseAgeType\": \"oldest\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Event Level**\n The event's level is `match` `level`\n - `match`: The comparison operator\n - `eq`: Equal\n - `gte`: Greater than or equal\n - `lte`: Less than or equal\n - `level`: The event level\n - `50`: Fatal\n - `40`: Error\n - `30`: Warning\n - `20`: Info\n - `10`: Debug\n - `0`: Sample\n\n ```json\n {\n \"type\": \"level\",\n \"comparison\": {\n \"level\": 50,\n \"match\": \"eq\"\n },\n \"conditionResult\": true\n }\n ```\n\n ## Actions\n A list of actions that take place when all required conditions and filters for the alert are met. See below for a list of possible actions.\n\n\n **Notify on Preferred Channel**\n - `data`: A dictionary with the fallthrough type option when choosing to notify Suggested Assignees. Leave empty if notifying a user or team.\n - `fallthroughType`\n - `ActiveMembers`\n - `AllMembers`\n - `NoOne`\n - `config`: A dictionary with the configuration options for notification.\n - `targetType`: The type of recipient to notify\n - `user`: User\n - `team`: Team\n - `issue_owners`: Suggested Assignees\n - `targetDisplay`: null\n - `targetIdentifier`: The id of the user or team to notify. Leave null for Suggested Assignees.\n\n ```json\n {\n \"type\":\"email\",\n \"integrationId\":null,\n \"data\":{},\n \"config\":{\n \"targetType\":\"user\",\n \"targetDisplay\":null,\n \"targetIdentifier\":\"232692\"\n },\n \"status\":\"active\"\n },\n {\n \"type\":\"email\",\n \"integrationId\":null,\n \"data\":{\n \"fallthroughType\":\"ActiveMembers\"\n },\n \"config\":{\n \"targetType\":\"issue_owners\",\n \"targetDisplay\":null,\n \"targetIdentifier\":\"\"}\n ,\n \"status\":\"active\"\n }\n ```\n **Notify on Slack**\n - `targetDisplay`: The name of the channel to notify in.\n `integrationId`: The stringified ID of the integration.\n\n ```json\n {\n \"type\":\"slack\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"\",\n \"targetDisplay\":\"notify-errors\"\n },\n \"integrationId\":\"1\",\n \"data\":{},\n \"status\":\"active\"\n }\n ```\n\n **Notify on PagerDuty**\n - `targetDisplay`: The name of the service to create the ticket in.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"priority\"]`: The severity level for the notification.\n\n ```json\n {\n \"type\":\"pagerduty\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"123456\",\n \"targetDisplay\":\"Error Service\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"priority\":\"default\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on Discord**\n - `targetDisplay`: The name of the service to create the ticket in.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"tags\"]`: Comma separated list of tags to add to the notification.\n\n ```json\n {\n \"type\":\"discord\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"12345\",\n \"targetDisplay\":\"\",\n },\n \"integrationId\":\"1234\",\n \"data\":{\n \"tags\":\"transaction,environment\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on MSTeams**\n - `targetIdentifier` - The integration ID associated with the Microsoft Teams team.\n - `targetDisplay` - The name of the channel to send the notification to.\n - `integrationId`: The stringified ID of the integration.\n ```json\n {\n \"type\":\"msteams\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"19:a4b3kghaghgkjah357y6847@thread.skype\",\n \"targetDisplay\":\"notify-errors\"\n },\n \"integrationId\":\"1\",\n \"data\":{},\n \"status\":\"active\"\n }\n ```\n\n **Notify on OpsGenie**\n - `targetDisplay`: The name of the Opsgenie team.\n - `targetIdentifier`: The ID of the Opsgenie team to send the notification to.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"priority\"]`: The priority level for the notification.\n\n ```json\n {\n \"type\":\"opsgenie\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"123456-Error-Service\",\n \"targetDisplay\":\"Error Service\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"priority\":\"P3\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on Azure DevOps**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"vsts\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a Jira ticket**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"jira\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a Jira Server ticket**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"jira_server\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a GitHub issue**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"github\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"additional_fields\": {\n \"assignee\": \"\",\n \"integration\": \"2345\",\n \"labels\": [],\n \"repo\": \"example-repo\",\n },\n \"dynamic_form_fields\": [\n {\n \"choices\": [[\"YourOrg/example-repo\", \"example-repo\"]],\n \"default\": \"YourOrg/example-repo\",\n \"label\": \"GitHub Repository\",\n \"name\": \"repo\",\n \"required\": true\n \"type\": \"select\",\n \"updatesForm\": true,\n \"url\": \"/extensions/github/search/example-repo/1234567/\",\n },\n ],\n },\n \"status\":\"active\"\n }\n ```\n " }, "owner": { "type": "string", "nullable": true, "description": "\n The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'.\n\n **User**\n ```json\n \"user:123456\"\n ```\n\n **Team**\n ```json\n \"team:456789\"\n ```\n " } }, "required": [ "name" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "triggers": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } }, "nullable": true }, "actionFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } } }, "nullable": true }, "environment": { "type": "string", "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "detectorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" }, "lastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "string", "nullable": true } }, "required": [ "actionFilters", "config", "createdBy", "dateCreated", "dateUpdated", "detectorIds", "enabled", "environment", "id", "lastTriggered", "name", "organizationId", "owner", "triggers" ] }, "examples": { "WorkflowSuccessfullyCreated": { "value": { "id": "1234567", "name": "Notify Jane Doe", "organizationId": "1", "createdBy": "2345", "dateCreated": "2026-01-13T21:21:15.975384Z", "dateUpdated": "2026-01-13T21:21:15.975376Z", "triggers": { "id": "456789", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "234567", "type": "first_seen_event", "comparison": true, "conditionResult": true }, { "id": "1234567", "type": "issue_resolved_trigger", "comparison": true, "conditionResult": true }, { "id": "678912", "type": "reappeared_event", "comparison": true, "conditionResult": true }, { "id": "7891234", "type": "regression_event", "comparison": true, "conditionResult": true } ], "actions": [] }, "actionFilters": [ { "id": "45678", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "23456789", "type": "issue_occurrences", "comparison": { "value": 10 }, "conditionResult": true } ], "actions": [ { "id": "1234789", "type": "email", "integrationId": null, "data": {}, "config": { "targetType": "user", "targetDisplay": null, "targetIdentifier": "6789" }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 1440 }, "detectorIds": [ "1000" ], "enabled": true, "lastTriggered": null, "owner": "user:123456" }, "summary": "Workflow successfully created" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Mutate an Organization's Alerts", "description": "Bulk enable or disable alerts for a given Organization", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "An optional search query for filtering alerts." }, { "in": "query", "name": "id", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the alert you'd like to query." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" } ], "tags": [ "Monitors" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether to enable or disable the alerts" } }, "required": [ "enabled" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "triggers": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } }, "nullable": true }, "actionFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } } }, "nullable": true }, "environment": { "type": "string", "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "detectorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" }, "lastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "string", "nullable": true } }, "required": [ "actionFilters", "config", "createdBy", "dateCreated", "dateUpdated", "detectorIds", "enabled", "environment", "id", "lastTriggered", "name", "organizationId", "owner", "triggers" ] } }, "examples": { "ListAllWorkflowsInAnOrganization": { "value": [ { "id": "123", "name": "Send a notification for high priority issues", "organizationId": "1", "createdBy": null, "dateCreated": "2025-03-18T20:48:55.495059Z", "dateUpdated": "2025-03-18T20:48:55.579094Z", "triggers": { "id": "12345", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "2345", "type": "new_high_priority_issue", "comparison": true, "conditionResult": true }, { "id": "3456", "type": "existing_high_priority_issue", "comparison": true, "conditionResult": true } ], "actions": [] }, "actionFilters": [ { "id": "5678", "organizationId": "1", "logicType": "all", "conditions": [], "actions": [ { "id": "234", "type": "email", "integrationId": null, "data": { "fallthroughType": "ActiveMembers" }, "config": { "targetType": "issue_owners", "targetDisplay": null, "targetIdentifier": null }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 30 }, "detectorIds": [], "enabled": true, "lastTriggered": null, "owner": "user:123456" }, { "id": "456", "name": "Notify team #example-team", "organizationId": "1", "createdBy": "34567", "dateCreated": "2026-01-15T23:46:39.594915Z", "dateUpdated": "2026-01-15T23:46:39.594903Z", "triggers": { "id": "12345", "organizationId": "1", "logicType": "any-short", "conditions": [], "actions": [] }, "actionFilters": [ { "id": "6789", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "5678", "type": "event_frequency_count", "comparison": { "value": 100, "interval": "1h" }, "conditionResult": true } ], "actions": [ { "id": "1234", "type": "email", "integrationId": null, "data": {}, "config": { "targetType": "team", "targetDisplay": null, "targetIdentifier": "1234567890" }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 1440 }, "detectorIds": [], "enabled": true, "lastTriggered": null, "owner": "team:456789" }, { "id": "789", "name": "Notify Jane Doe", "organizationId": "1", "createdBy": "2345", "dateCreated": "2026-01-15T23:46:39.594915Z", "dateUpdated": "2026-01-15T23:49:57.697583Z", "triggers": { "id": "56789", "organizationId": "1", "logicType": "any-short", "conditions": [], "actions": [] }, "actionFilters": [ { "id": "56789", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "234567", "type": "event_unique_user_frequency_count", "comparison": { "value": 100, "filters": [ { "key": "foo", "match": "eq", "value": "bar" } ], "interval": "1h" }, "conditionResult": true } ], "actions": [ { "id": "456789", "type": "email", "integrationId": null, "data": {}, "config": { "targetType": "user", "targetDisplay": null, "targetIdentifier": "123456" }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 1440 }, "detectorIds": [], "enabled": true, "lastTriggered": null, "owner": null } ], "summary": "List all workflows in an organization" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Bulk Delete Alerts", "description": "Bulk delete alerts for a given organization", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "An optional search query for filtering alerts." }, { "in": "query", "name": "id", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The ID of the alert you'd like to query." }, { "in": "query", "name": "project", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "The IDs of projects to filter by. `-1` means all available projects.\nFor example, the following are valid parameters:\n- `/?project=1234&project=56789`\n- `/?project=-1`\n" } ], "tags": [ "Monitors" ], "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:write" ] } ], "responses": { "200": { "description": "Success" }, "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/workflows/{workflow_id}/": { "get": { "operationId": "Fetch an Alert", "description": "Returns an alert.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "workflow_id", "schema": { "type": "integer" }, "description": "The ID of the alert you'd like to query.", "required": true } ], "tags": [ "Monitors" ], "security": [ { "auth_token": [ "alerts:read", "org:admin", "org:read", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "triggers": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } }, "nullable": true }, "actionFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } } }, "nullable": true }, "environment": { "type": "string", "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "detectorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" }, "lastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "string", "nullable": true } }, "required": [ "actionFilters", "config", "createdBy", "dateCreated", "dateUpdated", "detectorIds", "enabled", "environment", "id", "lastTriggered", "name", "organizationId", "owner", "triggers" ] }, "examples": { "FetchAnAlert": { "value": { "id": "6789123", "name": "My Alert", "organizationId": "1", "createdBy": "1234567", "dateCreated": "2026-01-14T20:08:32.273220Z", "dateUpdated": "2026-01-14T20:08:32.273209Z", "triggers": { "id": "345678", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "234", "type": "first_seen_event", "comparison": true, "conditionResult": true }, { "id": "567", "type": "issue_resolved_trigger", "comparison": true, "conditionResult": true }, { "id": "891", "type": "reappeared_event", "comparison": true, "conditionResult": true }, { "id": "789", "type": "regression_event", "comparison": true, "conditionResult": true } ], "actions": [] }, "actionFilters": [ { "id": "345678", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "234567", "type": "issue_priority_deescalating", "comparison": true, "conditionResult": true } ], "actions": [ { "id": "45678", "type": "slack", "integrationId": "1", "data": {}, "config": { "targetType": "specific", "targetDisplay": "@jane-doe", "targetIdentifier": "ABCDE123456" }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 1440 }, "detectorIds": [ "1234567" ], "enabled": true, "lastTriggered": null, "owner": "user:123456" }, "summary": "Fetch an Alert" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update an Alert by ID", "description": "Updates an alert.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "workflow_id", "schema": { "type": "integer" }, "description": "The ID of the alert you'd like to query.", "required": true } ], "tags": [ "Monitors" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "name": { "type": "string", "description": "The name of the alert", "maxLength": 256 }, "id": { "type": "string", "description": "The ID of the existing alert" }, "enabled": { "type": "boolean", "default": true, "description": "Whether the alert is enabled or disabled" }, "detector_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the monitors to connect this alert to. Use 'Fetch an Organization's Monitors' to find the IDs." }, "config": { "type": "object", "additionalProperties": {}, "description": "\n Typically the frequency at which the alert will fire, in minutes.\n\n - `0`: 0 minutes\n - `5`: 5 minutes\n - `10`: 10 minutes\n - `30`: 30 minutes\n - `60`: 1 hour\n - `180`: 3 hours\n - `720`: 12 hours\n - `1440`: 24 hours\n\n ```json\n {\n \"frequency\":3600\n }\n ```\n " }, "environment": { "type": "string", "nullable": true, "description": "The name of the environment for the alert to evaluate in" }, "triggers": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "logic_type": { "enum": [ "any", "any-short", "all", "none" ], "type": "string", "description": "* `any`\n* `any-short`\n* `all`\n* `none`" }, "conditions": { "type": "array", "items": {} } }, "required": [ "logic_type" ] } ], "description": "The conditions on which the alert will trigger. See available options below.\n ```json\n \"triggers\": {\n \"organizationId\": \"1\",\n \"logicType\": \"any-short\",\n \"conditions\": [\n {\n \"type\": \"first_seen_event\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"issue_resolved_trigger\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"reappeared_event\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"regression_event\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ],\n \"actions\": []\n }\n ```\n " }, "action_filters": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "The filters to run before the action will fire and the action(s) to fire.\n\n `logicType` can be one of `any-short`, `all`, or `none`.\n\n Below is a basic example. See below for all other options.\n\n ```json\n \"actionFilters\": [\n {\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"level\",\n \"comparison\": {\n \"level\": 50,\n \"match\": \"eq\"\n },\n \"conditionResult\": true\n }\n ],\n \"actions\": [\n {\n \"id\": \"123\",\n \"type\": \"email\",\n \"integrationId\": null,\n \"data\": {},\n \"config\": {\n \"targetType\": \"user\",\n \"targetDisplay\": null,\n \"targetIdentifier\": \"56789\"\n },\n \"status\": \"active\"\n }\n ]\n }\n ]\n ```\n\n ## Conditions\n\n **Issue Age**\n - `time`: One of `minute`, `hour`, `day`, or `week`.\n - `value`: A positive integer.\n - `comparisonType`: One of `older` or `newer`.\n ```json\n {\n \"type\": \"age_comparison\",\n \"comparison\": {\n \"time\": \"minute\",\n \"value\": 10,\n \"comparisonType\": \"older\"\n },\n \"conditionResult\": true\n }\n\n ```\n\n **Issue Assignment**\n - `targetType`: Who the issue is assigned to\n - `Unassigned`: Unassigned\n - `Member`: Assigned to a user\n - `Team`: Assigned to a team\n - `targetIdentifier`: The ID of the user or team from the `targetType`. Enter \"\" if `targetType` is `Unassigned`.\n ```json\n {\n \"type\": \"assigned_to\",\n \"comparison\": {\n \"targetType\": \"Member\",\n \"targetIdentifier\": 123456\n },\n \"conditionResult\": true\n }\n ```\n\n **Issue Category**\n - `value`: The issue category to filter to.\n - `1`: Error issues\n - `6`: Feedback issues\n - `10`: Outage issues\n - `11`: Metric issues\n - `12`: DB Query issues\n - `13`: HTTP Client issues\n - `14`: Front end issues\n - `15`: Mobile issues\n ```json\n {\n \"type\": \"issue_category\",\n \"comparison\": {\n \"value\": 1\n },\n \"conditionResult\": true\n }\n ```\n\n **Issue Frequency**\n - `value`: A positive integer representing how many times the issue has to happen before the alert will fire.\n ```json\n {\n \"type\": \"issue_occurrences\",\n \"comparison\": {\n \"value\": 10\n },\n \"conditionResult\": true\n }\n ```\n\n **De-escalation**\n ```json\n {\n \"type\": \"issue_priority_deescalating\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ```\n\n **Issue Priority**\n - `comparison`: The priority the issue must be for the alert to fire.\n - `75`: High priority\n - `50`: Medium priority\n - `25`: Low priority\n ```json\n {\n \"type\": \"issue_priority_greater_or_equal\",\n \"comparison\": 75,\n \"conditionResult\": true\n }\n ```\n\n **Number of Users Affected**\n - `value`: A positive integer representing the number of users that must be affected before the alert will fire.\n - `filters`: A list of additional sub-filters to evaluate before the alert will fire.\n - `interval`: The time period in which to evaluate the value. e.g. Number of users affected by an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"event_unique_user_frequency_count\",\n \"comparison\": {\n \"value\": 100,\n \"filters\": [{\"key\": \"foo\", \"match\": \"eq\", \"value\": \"bar\"}],\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Number of Events**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"event_frequency_count\",\n \"comparison\": {\n \"value\": 100,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Percent of Events**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is `comparisonInterval` percent higher `value` compared to `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n - `comparisonInterval`: The time period to compare against. See `interval` for options.\n ```json\n {\n \"type\": \"event_frequency_percent\",\n \"comparison\": {\n \"value\": 100,\n \"interval\": \"1h\",\n \"comparisonInterval\": \"1w\"\n },\n \"conditionResult\": true\n }\n\n ```\n\n **Percentage of Sessions Affected Count**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"percent_sessions_count\",\n \"comparison\": {\n \"value\": 10,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Percentage of Sessions Affected Percent**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is `comparisonInterval` percent higher `value` compared to `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n - `comparisonInterval`: The time period to compare against. See `interval` for options.\n ```json\n {\n \"type\": \"percent_sessions_percent\",\n \"comparison\": {\n \"value\": 10,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Event Attribute**\n The event's `attribute` value `match` `value`\n\n - `attribute`: The event attribute to match on. Valid values are: `message`, `platform`, `environment`, `type`, `error.handled`, `error.unhandled`, `error.main_thread`, `exception.type`, `exception.value`, `user.id`, `user.email`, `user.username`, `user.ip_address`, `http.method`, `http.url`, `http.status_code`, `sdk.name`, `stacktrace.code`, `stacktrace.module`, `stacktrace.filename`, `stacktrace.abs_path`, `stacktrace.package`, `unreal.crash_type`, `app.in_foreground`.\n - `match`: The comparison operator\n - `co`: Contains\n - `nc`: Does not contain\n - `eq`: Equals\n - `ne`: Does not equal\n - `sw`: Starts with\n - `ew`: Ends with\n - `is`: Is set\n - `ns`: Is not set\n - `value`: A string. Not required when match is `is` or `ns`.\n\n ```json\n {\n \"type\": \"event_attribute\",\n \"comparison\": {\n \"match\": \"co\",\n \"value\": \"bar\",\n \"attribute\": \"message\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Tagged Event**\n The event's tags `key` match `value`\n - `key`: The tag value\n - `match`: The comparison operator\n - `co`: Contains\n - `nc`: Does not contain\n - `eq`: Equals\n - `ne`: Does not equal\n - `sw`: Starts with\n - `ew`: Ends with\n - `is`: Is set\n - `ns`: Is not set\n - `value`: A string. Not required when match is `is` or `ns`.\n\n ```json\n {\n \"type\": \"tagged_event\",\n \"comparison\": {\n \"key\": \"level\",\n \"match\": \"eq\",\n \"value\": \"error\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Latest Release**\n The event is from the latest release\n\n ```json\n {\n \"type\": \"latest_release\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ```\n\n **Release Age**\n ```json\n {\n \"type\": \"latest_adopted_release\",\n \"comparison\": {\n \"environment\": \"12345\",\n \"ageComparison\": \"older\",\n \"releaseAgeType\": \"oldest\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Event Level**\n The event's level is `match` `level`\n - `match`: The comparison operator\n - `eq`: Equal\n - `gte`: Greater than or equal\n - `lte`: Less than or equal\n - `level`: The event level\n - `50`: Fatal\n - `40`: Error\n - `30`: Warning\n - `20`: Info\n - `10`: Debug\n - `0`: Sample\n\n ```json\n {\n \"type\": \"level\",\n \"comparison\": {\n \"level\": 50,\n \"match\": \"eq\"\n },\n \"conditionResult\": true\n }\n ```\n\n ## Actions\n A list of actions that take place when all required conditions and filters for the alert are met. See below for a list of possible actions.\n\n\n **Notify on Preferred Channel**\n - `data`: A dictionary with the fallthrough type option when choosing to notify Suggested Assignees. Leave empty if notifying a user or team.\n - `fallthroughType`\n - `ActiveMembers`\n - `AllMembers`\n - `NoOne`\n - `config`: A dictionary with the configuration options for notification.\n - `targetType`: The type of recipient to notify\n - `user`: User\n - `team`: Team\n - `issue_owners`: Suggested Assignees\n - `targetDisplay`: null\n - `targetIdentifier`: The id of the user or team to notify. Leave null for Suggested Assignees.\n\n ```json\n {\n \"type\":\"email\",\n \"integrationId\":null,\n \"data\":{},\n \"config\":{\n \"targetType\":\"user\",\n \"targetDisplay\":null,\n \"targetIdentifier\":\"232692\"\n },\n \"status\":\"active\"\n },\n {\n \"type\":\"email\",\n \"integrationId\":null,\n \"data\":{\n \"fallthroughType\":\"ActiveMembers\"\n },\n \"config\":{\n \"targetType\":\"issue_owners\",\n \"targetDisplay\":null,\n \"targetIdentifier\":\"\"}\n ,\n \"status\":\"active\"\n }\n ```\n **Notify on Slack**\n - `targetDisplay`: The name of the channel to notify in.\n `integrationId`: The stringified ID of the integration.\n\n ```json\n {\n \"type\":\"slack\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"\",\n \"targetDisplay\":\"notify-errors\"\n },\n \"integrationId\":\"1\",\n \"data\":{},\n \"status\":\"active\"\n }\n ```\n\n **Notify on PagerDuty**\n - `targetDisplay`: The name of the service to create the ticket in.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"priority\"]`: The severity level for the notification.\n\n ```json\n {\n \"type\":\"pagerduty\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"123456\",\n \"targetDisplay\":\"Error Service\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"priority\":\"default\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on Discord**\n - `targetDisplay`: The name of the service to create the ticket in.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"tags\"]`: Comma separated list of tags to add to the notification.\n\n ```json\n {\n \"type\":\"discord\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"12345\",\n \"targetDisplay\":\"\",\n },\n \"integrationId\":\"1234\",\n \"data\":{\n \"tags\":\"transaction,environment\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on MSTeams**\n - `targetIdentifier` - The integration ID associated with the Microsoft Teams team.\n - `targetDisplay` - The name of the channel to send the notification to.\n - `integrationId`: The stringified ID of the integration.\n ```json\n {\n \"type\":\"msteams\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"19:a4b3kghaghgkjah357y6847@thread.skype\",\n \"targetDisplay\":\"notify-errors\"\n },\n \"integrationId\":\"1\",\n \"data\":{},\n \"status\":\"active\"\n }\n ```\n\n **Notify on OpsGenie**\n - `targetDisplay`: The name of the Opsgenie team.\n - `targetIdentifier`: The ID of the Opsgenie team to send the notification to.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"priority\"]`: The priority level for the notification.\n\n ```json\n {\n \"type\":\"opsgenie\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"123456-Error-Service\",\n \"targetDisplay\":\"Error Service\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"priority\":\"P3\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on Azure DevOps**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"vsts\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a Jira ticket**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"jira\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a Jira Server ticket**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"jira_server\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a GitHub issue**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"github\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"additional_fields\": {\n \"assignee\": \"\",\n \"integration\": \"2345\",\n \"labels\": [],\n \"repo\": \"example-repo\",\n },\n \"dynamic_form_fields\": [\n {\n \"choices\": [[\"YourOrg/example-repo\", \"example-repo\"]],\n \"default\": \"YourOrg/example-repo\",\n \"label\": \"GitHub Repository\",\n \"name\": \"repo\",\n \"required\": true\n \"type\": \"select\",\n \"updatesForm\": true,\n \"url\": \"/extensions/github/search/example-repo/1234567/\",\n },\n ],\n },\n \"status\":\"active\"\n }\n ```\n " }, "owner": { "type": "string", "nullable": true, "description": "\n The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'.\n\n **User**\n ```json\n \"user:123456\"\n ```\n\n **Team**\n ```json\n \"team:456789\"\n ```\n " } }, "required": [ "name" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "triggers": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } }, "nullable": true }, "actionFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } } }, "nullable": true }, "environment": { "type": "string", "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "detectorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" }, "lastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "string", "nullable": true } }, "required": [ "actionFilters", "config", "createdBy", "dateCreated", "dateUpdated", "detectorIds", "enabled", "environment", "id", "lastTriggered", "name", "organizationId", "owner", "triggers" ] }, "examples": { "UpdateAnAlert": { "value": { "id": "1234567", "name": "My Updated Alert", "organizationId": "1", "createdBy": "23456", "dateCreated": "2026-01-14T20:08:32.273220Z", "dateUpdated": "2026-01-14T21:59:45.609912Z", "triggers": { "id": "12345", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "1234", "type": "first_seen_event", "comparison": true, "conditionResult": true }, { "id": "2345", "type": "issue_resolved_trigger", "comparison": true, "conditionResult": true }, { "id": "3456", "type": "reappeared_event", "comparison": true, "conditionResult": true }, { "id": "4567", "type": "regression_event", "comparison": true, "conditionResult": true } ], "actions": [] }, "actionFilters": [ { "id": "1234567", "organizationId": "1", "logicType": "any-short", "conditions": [ { "id": "345678", "type": "issue_priority_deescalating", "comparison": true, "conditionResult": true } ], "actions": [ { "id": "56789", "type": "slack", "integrationId": "1", "data": {}, "config": { "targetType": "specific", "targetDisplay": "@jane-doe", "targetIdentifier": "ABCDE123456" }, "status": "active" } ] } ], "environment": null, "config": { "frequency": 1440 }, "detectorIds": [ "12345678" ], "enabled": true, "lastTriggered": null, "owner": "user:123456" }, "summary": "Update an Alert" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete an Alert", "description": "Deletes an alert.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "workflow_id", "schema": { "type": "integer" }, "description": "The ID of the alert you'd like to query.", "required": true } ], "tags": [ "Monitors" ], "security": [ { "auth_token": [ "alerts:write", "org:admin", "org:write" ] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/": { "get": { "operationId": "Retrieve a Project", "description": "Return details on an individual project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "digestsMinDelay": { "type": "integer" }, "digestsMaxDelay": { "type": "integer" }, "subjectPrefix": { "type": "string" }, "allowedDomains": { "type": "array", "items": { "type": "string" } }, "resolveAge": { "type": "integer" }, "dataScrubber": { "type": "boolean" }, "dataScrubberDefaults": { "type": "boolean" }, "safeFields": { "type": "array", "items": { "type": "string" } }, "storeCrashReports": { "type": "integer", "nullable": true }, "sensitiveFields": { "type": "array", "items": { "type": "string" } }, "subjectTemplate": { "type": "string" }, "securityToken": { "type": "string" }, "securityTokenHeader": { "type": "string", "nullable": true }, "verifySSL": { "type": "boolean" }, "scrubIPAddresses": { "type": "boolean" }, "scrapeJavaScript": { "type": "boolean" }, "highlightTags": { "type": "array", "items": { "type": "string" } }, "highlightContext": { "type": "object", "additionalProperties": {} }, "highlightPreset": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "context": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "context", "tags" ] }, "groupingConfig": { "type": "string" }, "derivedGroupingEnhancements": { "type": "string" }, "groupingEnhancements": { "type": "string" }, "secondaryGroupingExpiry": { "type": "integer" }, "secondaryGroupingConfig": { "type": "string", "nullable": true }, "fingerprintingRules": { "type": "string" }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "plugins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "shortName": { "type": "string" }, "type": { "type": "string" }, "canDisable": { "type": "boolean" }, "isTestable": { "type": "boolean" }, "hasConfiguration": { "type": "boolean" }, "metadata": { "type": "object", "additionalProperties": {} }, "contexts": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "assets": { "type": "array", "items": {} }, "doc": { "type": "string" }, "firstPartyAlternative": {}, "deprecationDate": {}, "altIsSentryApp": {}, "enabled": { "type": "boolean" }, "version": { "type": "string" }, "author": { "type": "object", "additionalProperties": { "type": "string" } }, "isDeprecated": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "featureDescriptions": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "resourceLinks": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } }, "required": [ "altIsSentryApp", "assets", "author", "canDisable", "contexts", "deprecationDate", "description", "doc", "enabled", "featureDescriptions", "features", "firstPartyAlternative", "hasConfiguration", "id", "isDeprecated", "isHidden", "isTestable", "metadata", "name", "resourceLinks", "shortName", "slug", "status", "type", "version" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "processingIssues": { "type": "integer" }, "defaultEnvironment": { "type": "string", "nullable": true }, "relayPiiConfig": { "type": "string", "nullable": true }, "builtinSymbolSources": { "type": "array", "items": { "type": "string" } }, "dynamicSamplingBiases": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] } } }, "symbolSources": { "type": "string" }, "isDynamicallySampled": { "type": "boolean" }, "tempestFetchScreenshots": { "type": "boolean" }, "autofixAutomationTuning": { "type": "string" }, "seerScannerAutomation": { "type": "boolean" }, "seerNightshiftTweaks": {}, "scmSourceContextEnabled": { "type": "boolean" }, "debugFilesRole": { "type": "string", "nullable": true } }, "required": [ "access", "allowedDomains", "autofixAutomationTuning", "avatar", "builtinSymbolSources", "color", "dataScrubber", "dataScrubberDefaults", "dateCreated", "debugFilesRole", "defaultEnvironment", "derivedGroupingEnhancements", "digestsMaxDelay", "digestsMinDelay", "dynamicSamplingBiases", "features", "fingerprintingRules", "firstEvent", "firstTransactionEvent", "groupingConfig", "groupingEnhancements", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "highlightContext", "highlightPreset", "highlightTags", "id", "isBookmarked", "isDynamicallySampled", "isInternal", "isMember", "isPublic", "latestRelease", "name", "options", "organization", "platform", "platforms", "plugins", "processingIssues", "relayPiiConfig", "resolveAge", "safeFields", "scmSourceContextEnabled", "scrapeJavaScript", "scrubIPAddresses", "secondaryGroupingConfig", "secondaryGroupingExpiry", "securityToken", "securityTokenHeader", "seerNightshiftTweaks", "seerScannerAutomation", "sensitiveFields", "slug", "status", "storeCrashReports", "subjectPrefix", "subjectTemplate", "symbolSources", "teams", "tempestFetchScreenshots", "verifySSL" ] }, "examples": { "GetDetailedViewAboutAProject": { "value": { "id": "4505278496", "slug": "pump-station", "name": "Pump Station", "platform": "python", "dateCreated": "2021-01-14T22:08:52.711809Z", "isBookmarked": false, "isMember": true, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": "2021-01-14T22:08:52.711809Z", "firstTransactionEvent": true, "access": [ "member:read", "event:read", "project:admin", "team:write", "project:write", "team:admin", "project:read", "org:integrations", "org:read", "project:releases", "team:read", "alerts:write", "event:admin", "event:write", "alerts:read" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasFeedbacks": false, "hasMonitors": false, "hasNewFeedbacks": false, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasSessions": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#3f70bf", "status": "active", "team": { "id": "2", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" }, "teams": [ { "id": "2", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" } ], "latestRelease": { "version": "backend@3e90a5d9e767ebcfa70e921d7a7ff6c037461168" }, "options": { "sentry:transaction_name_cluster_rules": [], "digests:mail:maximum_delay": 600, "sentry:scrub_defaults": false, "sentry:scrape_javascript": true, "mail:subject_prefix": "", "sentry:relay_pii_config": null, "sentry:scrub_data": false, "sentry:token": "e84c8c0fb1c121e988558785885f9cde", "sentry:resolve_age": 168, "sentry:grouping_config": "newstyle:2012-12-31", "quotas:spike-protection-disabled": false, "sentry:store_crash_reports": 5, "digests:mail:minimum_delay": 180, "sentry:secondary_grouping_config": "newstyle:2012-11-21", "sentry:secondary_grouping_expiry": 147555024, "sentry:builtin_symbol_sources": [ "ios", "android", "chromium" ], "sentry:origins": [ "getsentry.com", "app.getsentry.com", "www.getsentry.com", "sentry.io" ], "sentry:sensitive_fields": [ "sudo" ], "sentry:scrub_ip_address": false, "sentry:default_environment": "prod", "sentry:verify_ssl": true, "sentry:csp_ignored_sources_defaults": true, "sentry:csp_ignored_sources": "", "filters:blacklisted_ips": "", "filters:react-hydration-errors": true, "filters:chunk-load-error": true, "filters:releases": "", "filters:error_messages": "", "feedback:branding": true }, "digestsMinDelay": 180, "digestsMaxDelay": 600, "subjectPrefix": "", "allowedDomains": [ "getsentry.com", "app.getsentry.com", "www.getsentry.com", "sentry.io" ], "resolveAge": 168, "dataScrubber": false, "dataScrubberDefaults": false, "safeFields": [], "storeCrashReports": 5, "sensitiveFields": [ "sudo" ], "subjectTemplate": "$shortID - $title", "securityToken": "e84c8c0fb1c121e988558785885f9cde", "securityTokenHeader": null, "verifySSL": true, "scrubIPAddresses": false, "scrapeJavaScript": true, "groupingConfig": "newstyle:2012-12-31", "groupingEnhancements": "", "derivedGroupingEnhancements": "", "secondaryGroupingExpiry": 1687010243, "secondaryGroupingConfig": "newstyle:2012-11-21", "fingerprintingRules": "", "organization": { "id": "1", "slug": "sentry", "status": { "id": "active", "name": "active" }, "name": "Sentry", "dateCreated": "2014-12-15T04:06:24.263571Z", "isEarlyAdopter": true, "allowMemberInvite": true, "allowMemberProjectCreation": true, "allowSuperuserAccess": false, "require2FA": false, "avatar": { "avatarType": "upload", "avatarUuid": "24f6f762f7a7473888b259c566da5adb" }, "features": [ "discover-basic", "incidents", "uptime", "monitors" ], "links": { "organizationUrl": "https://sentry.sentry.io", "regionUrl": "https://us.sentry.io" }, "hasAuthProvider": true }, "plugins": [ { "id": "asana", "name": "Asana", "slug": "asana", "shortName": "Asana", "type": "issue-tracking", "canDisable": true, "isTestable": false, "hasConfiguration": true, "metadata": {}, "contexts": [], "status": "unknown", "assets": [], "doc": "", "firstPartyAlternative": null, "deprecationDate": null, "altIsSentryApp": null, "enabled": true, "version": "23.7.0.dev0", "author": { "name": "Sentry Team", "url": "https://github.com/getsentry/sentry" }, "isDeprecated": false, "isHidden": false, "description": "\nImprove your productivity by creating tasks in Asana directly\nfrom Sentry issues. This integration also allows you to link Sentry\nissues to existing tasks in Asana.\n", "features": [ "issue-basic" ], "featureDescriptions": [ { "description": "Create and link Sentry issue groups directly to an Asana ticket in any of your\n projects, providing a quick way to jump from a Sentry bug to tracked ticket.", "featureGate": "issue-basic" }, { "description": "Link Sentry issues to existing Asana tickets.", "featureGate": "issue-basic" } ], "resourceLinks": [ { "title": "Report Issue", "url": "https://github.com/getsentry/sentry/issues" }, { "title": "View Source", "url": "https://github.com/getsentry/sentry/tree/master/src/sentry_plugins" } ] } ], "platforms": [ "native", "other", "python" ], "processingIssues": 0, "defaultEnvironment": "prod", "relayPiiConfig": null, "builtinSymbolSources": [ "ios", "android", "chromium" ], "dynamicSamplingBiases": [ { "id": "boostEnvironments", "active": true }, { "id": "boostLatestRelease", "active": true }, { "id": "ignoreHealthChecks", "active": true }, { "id": "boostKeyTransactions", "active": true }, { "id": "boostLowVolumeTransactions", "active": true }, { "id": "boostReplayId", "active": true }, { "id": "recalibrationRule", "active": true } ], "symbolSources": "[]", "tempestFetchScreenshots": false, "debugFilesRole": null, "isDynamicallySampled": true, "autofixAutomationTuning": "off", "seerScannerAutomation": true, "seerNightshiftTweaks": null, "highlightTags": [], "highlightContext": {}, "highlightPreset": { "tags": [], "context": {} }, "scmSourceContextEnabled": false }, "summary": "Get detailed view about a Project" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update a Project", "description": "Update various attributes and configurable settings for the given project.\n\nNote that solely having the **`project:read`** scope restricts updatable settings to\n`isBookmarked`, `autofixAutomationTuning`, `seerScannerAutomation`,\n`preprodSizeStatusChecksEnabled`, `preprodSizeStatusChecksRules`,\n`preprodSizeEnabledQuery`, `preprodDistributionEnabledQuery`,\n`preprodSizeEnabledByCustomer`, `preprodDistributionEnabledByCustomer`,\nand `preprodDistributionPrCommentsEnabledByCustomer`.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "isBookmarked": { "type": "boolean", "description": "Enables starring the project within the projects tab. Can be updated with **`project:read`** permission." }, "name": { "type": "string", "description": "The name for the project", "maxLength": 200 }, "slug": { "type": "string", "description": "Uniquely identifies a project and is used for the interface.", "maxLength": 100, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "platform": { "type": "string", "nullable": true, "description": "The platform for the project" }, "subjectPrefix": { "type": "string", "description": "Custom prefix for emails from this project.", "maxLength": 200 }, "subjectTemplate": { "type": "string", "description": "The email subject to use (excluding the prefix) for individual alerts. Here are the list of variables you can use:\n- `$title`\n- `$shortID`\n- `$projectID`\n- `$orgID`\n- `${tag:key}` - such as `${tag:environment}` or `${tag:release}`.", "maxLength": 200 }, "resolveAge": { "type": "integer", "nullable": true, "description": "Automatically resolve an issue if it hasn't been seen for this many hours. Set to `0` to disable auto-resolve." }, "highlightContext": { "type": "object", "additionalProperties": {}, "description": "A JSON mapping of context types to lists of strings for their keys.\nE.g. `{'user': ['id', 'email']}`" }, "highlightTags": { "type": "array", "items": { "type": "string" }, "description": "A list of strings with tag keys to highlight on this project's issues.\nE.g. `['release', 'environment']`" }, "scmSourceContextEnabled": { "type": "boolean", "description": "Enable on-demand source context fetching from SCM integrations for stack traces." } } } } } }, "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "digestsMinDelay": { "type": "integer" }, "digestsMaxDelay": { "type": "integer" }, "subjectPrefix": { "type": "string" }, "allowedDomains": { "type": "array", "items": { "type": "string" } }, "resolveAge": { "type": "integer" }, "dataScrubber": { "type": "boolean" }, "dataScrubberDefaults": { "type": "boolean" }, "safeFields": { "type": "array", "items": { "type": "string" } }, "storeCrashReports": { "type": "integer", "nullable": true }, "sensitiveFields": { "type": "array", "items": { "type": "string" } }, "subjectTemplate": { "type": "string" }, "securityToken": { "type": "string" }, "securityTokenHeader": { "type": "string", "nullable": true }, "verifySSL": { "type": "boolean" }, "scrubIPAddresses": { "type": "boolean" }, "scrapeJavaScript": { "type": "boolean" }, "highlightTags": { "type": "array", "items": { "type": "string" } }, "highlightContext": { "type": "object", "additionalProperties": {} }, "highlightPreset": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "context": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "context", "tags" ] }, "groupingConfig": { "type": "string" }, "derivedGroupingEnhancements": { "type": "string" }, "groupingEnhancements": { "type": "string" }, "secondaryGroupingExpiry": { "type": "integer" }, "secondaryGroupingConfig": { "type": "string", "nullable": true }, "fingerprintingRules": { "type": "string" }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "plugins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "shortName": { "type": "string" }, "type": { "type": "string" }, "canDisable": { "type": "boolean" }, "isTestable": { "type": "boolean" }, "hasConfiguration": { "type": "boolean" }, "metadata": { "type": "object", "additionalProperties": {} }, "contexts": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "assets": { "type": "array", "items": {} }, "doc": { "type": "string" }, "firstPartyAlternative": {}, "deprecationDate": {}, "altIsSentryApp": {}, "enabled": { "type": "boolean" }, "version": { "type": "string" }, "author": { "type": "object", "additionalProperties": { "type": "string" } }, "isDeprecated": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "featureDescriptions": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "resourceLinks": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } }, "required": [ "altIsSentryApp", "assets", "author", "canDisable", "contexts", "deprecationDate", "description", "doc", "enabled", "featureDescriptions", "features", "firstPartyAlternative", "hasConfiguration", "id", "isDeprecated", "isHidden", "isTestable", "metadata", "name", "resourceLinks", "shortName", "slug", "status", "type", "version" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "processingIssues": { "type": "integer" }, "defaultEnvironment": { "type": "string", "nullable": true }, "relayPiiConfig": { "type": "string", "nullable": true }, "builtinSymbolSources": { "type": "array", "items": { "type": "string" } }, "dynamicSamplingBiases": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] } } }, "symbolSources": { "type": "string" }, "isDynamicallySampled": { "type": "boolean" }, "tempestFetchScreenshots": { "type": "boolean" }, "autofixAutomationTuning": { "type": "string" }, "seerScannerAutomation": { "type": "boolean" }, "seerNightshiftTweaks": {}, "scmSourceContextEnabled": { "type": "boolean" }, "debugFilesRole": { "type": "string", "nullable": true } }, "required": [ "access", "allowedDomains", "autofixAutomationTuning", "avatar", "builtinSymbolSources", "color", "dataScrubber", "dataScrubberDefaults", "dateCreated", "debugFilesRole", "defaultEnvironment", "derivedGroupingEnhancements", "digestsMaxDelay", "digestsMinDelay", "dynamicSamplingBiases", "features", "fingerprintingRules", "firstEvent", "firstTransactionEvent", "groupingConfig", "groupingEnhancements", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "highlightContext", "highlightPreset", "highlightTags", "id", "isBookmarked", "isDynamicallySampled", "isInternal", "isMember", "isPublic", "latestRelease", "name", "options", "organization", "platform", "platforms", "plugins", "processingIssues", "relayPiiConfig", "resolveAge", "safeFields", "scmSourceContextEnabled", "scrapeJavaScript", "scrubIPAddresses", "secondaryGroupingConfig", "secondaryGroupingExpiry", "securityToken", "securityTokenHeader", "seerNightshiftTweaks", "seerScannerAutomation", "sensitiveFields", "slug", "status", "storeCrashReports", "subjectPrefix", "subjectTemplate", "symbolSources", "teams", "tempestFetchScreenshots", "verifySSL" ] }, "examples": { "GetDetailedViewAboutAProject": { "value": { "id": "4505278496", "slug": "pump-station", "name": "Pump Station", "platform": "python", "dateCreated": "2021-01-14T22:08:52.711809Z", "isBookmarked": false, "isMember": true, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": "2021-01-14T22:08:52.711809Z", "firstTransactionEvent": true, "access": [ "member:read", "event:read", "project:admin", "team:write", "project:write", "team:admin", "project:read", "org:integrations", "org:read", "project:releases", "team:read", "alerts:write", "event:admin", "event:write", "alerts:read" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasFeedbacks": false, "hasMonitors": false, "hasNewFeedbacks": false, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasSessions": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#3f70bf", "status": "active", "team": { "id": "2", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" }, "teams": [ { "id": "2", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" } ], "latestRelease": { "version": "backend@3e90a5d9e767ebcfa70e921d7a7ff6c037461168" }, "options": { "sentry:transaction_name_cluster_rules": [], "digests:mail:maximum_delay": 600, "sentry:scrub_defaults": false, "sentry:scrape_javascript": true, "mail:subject_prefix": "", "sentry:relay_pii_config": null, "sentry:scrub_data": false, "sentry:token": "e84c8c0fb1c121e988558785885f9cde", "sentry:resolve_age": 168, "sentry:grouping_config": "newstyle:2012-12-31", "quotas:spike-protection-disabled": false, "sentry:store_crash_reports": 5, "digests:mail:minimum_delay": 180, "sentry:secondary_grouping_config": "newstyle:2012-11-21", "sentry:secondary_grouping_expiry": 147555024, "sentry:builtin_symbol_sources": [ "ios", "android", "chromium" ], "sentry:origins": [ "getsentry.com", "app.getsentry.com", "www.getsentry.com", "sentry.io" ], "sentry:sensitive_fields": [ "sudo" ], "sentry:scrub_ip_address": false, "sentry:default_environment": "prod", "sentry:verify_ssl": true, "sentry:csp_ignored_sources_defaults": true, "sentry:csp_ignored_sources": "", "filters:blacklisted_ips": "", "filters:react-hydration-errors": true, "filters:chunk-load-error": true, "filters:releases": "", "filters:error_messages": "", "feedback:branding": true }, "digestsMinDelay": 180, "digestsMaxDelay": 600, "subjectPrefix": "", "allowedDomains": [ "getsentry.com", "app.getsentry.com", "www.getsentry.com", "sentry.io" ], "resolveAge": 168, "dataScrubber": false, "dataScrubberDefaults": false, "safeFields": [], "storeCrashReports": 5, "sensitiveFields": [ "sudo" ], "subjectTemplate": "$shortID - $title", "securityToken": "e84c8c0fb1c121e988558785885f9cde", "securityTokenHeader": null, "verifySSL": true, "scrubIPAddresses": false, "scrapeJavaScript": true, "groupingConfig": "newstyle:2012-12-31", "groupingEnhancements": "", "derivedGroupingEnhancements": "", "secondaryGroupingExpiry": 1687010243, "secondaryGroupingConfig": "newstyle:2012-11-21", "fingerprintingRules": "", "organization": { "id": "1", "slug": "sentry", "status": { "id": "active", "name": "active" }, "name": "Sentry", "dateCreated": "2014-12-15T04:06:24.263571Z", "isEarlyAdopter": true, "allowMemberInvite": true, "allowMemberProjectCreation": true, "allowSuperuserAccess": false, "require2FA": false, "avatar": { "avatarType": "upload", "avatarUuid": "24f6f762f7a7473888b259c566da5adb" }, "features": [ "discover-basic", "incidents", "uptime", "monitors" ], "links": { "organizationUrl": "https://sentry.sentry.io", "regionUrl": "https://us.sentry.io" }, "hasAuthProvider": true }, "plugins": [ { "id": "asana", "name": "Asana", "slug": "asana", "shortName": "Asana", "type": "issue-tracking", "canDisable": true, "isTestable": false, "hasConfiguration": true, "metadata": {}, "contexts": [], "status": "unknown", "assets": [], "doc": "", "firstPartyAlternative": null, "deprecationDate": null, "altIsSentryApp": null, "enabled": true, "version": "23.7.0.dev0", "author": { "name": "Sentry Team", "url": "https://github.com/getsentry/sentry" }, "isDeprecated": false, "isHidden": false, "description": "\nImprove your productivity by creating tasks in Asana directly\nfrom Sentry issues. This integration also allows you to link Sentry\nissues to existing tasks in Asana.\n", "features": [ "issue-basic" ], "featureDescriptions": [ { "description": "Create and link Sentry issue groups directly to an Asana ticket in any of your\n projects, providing a quick way to jump from a Sentry bug to tracked ticket.", "featureGate": "issue-basic" }, { "description": "Link Sentry issues to existing Asana tickets.", "featureGate": "issue-basic" } ], "resourceLinks": [ { "title": "Report Issue", "url": "https://github.com/getsentry/sentry/issues" }, { "title": "View Source", "url": "https://github.com/getsentry/sentry/tree/master/src/sentry_plugins" } ] } ], "platforms": [ "native", "other", "python" ], "processingIssues": 0, "defaultEnvironment": "prod", "relayPiiConfig": null, "builtinSymbolSources": [ "ios", "android", "chromium" ], "dynamicSamplingBiases": [ { "id": "boostEnvironments", "active": true }, { "id": "boostLatestRelease", "active": true }, { "id": "ignoreHealthChecks", "active": true }, { "id": "boostKeyTransactions", "active": true }, { "id": "boostLowVolumeTransactions", "active": true }, { "id": "boostReplayId", "active": true }, { "id": "recalibrationRule", "active": true } ], "symbolSources": "[]", "tempestFetchScreenshots": false, "debugFilesRole": null, "isDynamicallySampled": true, "autofixAutomationTuning": "off", "seerScannerAutomation": true, "seerNightshiftTweaks": null, "highlightTags": [], "highlightContext": {}, "highlightPreset": { "tags": [], "context": {} }, "scmSourceContextEnabled": false }, "summary": "Get detailed view about a Project" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete a Project", "description": "Schedules a project for deletion.\n\nDeletion happens asynchronously and therefore is not immediate. However once deletion has\nbegun the state of a project changes and will be hidden from most public views.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/environments/": { "get": { "operationId": "List a Project's Environments", "description": "Lists a project's environments.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "query", "name": "visibility", "schema": { "type": "string", "enum": [ "all", "hidden", "visible" ] }, "description": "The visibility of the environments to filter by. Defaults to `visible`." } ], "tags": [ "Environments" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isHidden": { "type": "boolean" } }, "required": [ "id", "isHidden", "name" ] } }, "examples": { "ListAProject'sEnvironments": { "value": [ { "id": "1", "name": "Production", "isHidden": false }, { "id": "2", "name": "Staging", "isHidden": true } ], "summary": "List a Project's Environments" } } } }, "description": "" }, "400": { "description": "Invalid value for 'visibility'." }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/environments/{environment}/": { "get": { "operationId": "Retrieve a Project Environment", "description": "Return details on a project environment.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "environment", "schema": { "type": "string" }, "description": "The name of the environment.", "required": true } ], "tags": [ "Environments" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isHidden": { "type": "boolean" } }, "required": [ "id", "isHidden", "name" ] }, "examples": { "RetrieveAProjectEnvironment": { "value": { "id": "1", "name": "Production", "isHidden": false }, "summary": "Retrieve a Project Environment" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update a Project Environment", "description": "Update the visibility for a project environment.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "environment", "schema": { "type": "string" }, "description": "The name of the environment.", "required": true } ], "tags": [ "Environments" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "isHidden": { "type": "boolean", "description": "Specify `true` to make the environment visible or `false` to make the environment hidden." } }, "required": [ "isHidden" ] } } }, "required": true }, "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isHidden": { "type": "boolean" } }, "required": [ "id", "isHidden", "name" ] }, "examples": { "RetrieveAProjectEnvironment": { "value": { "id": "1", "name": "Production", "isHidden": false }, "summary": "Retrieve a Project Environment" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/events/": { "get": { "operationId": "List a Project's Error Events", "description": "Return a list of events bound to a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string" }, "description": "The period of time for the query, will override the start & end parameters, a number followed by one of:\n- `d` for days\n- `h` for hours\n- `m` for minutes\n- `s` for seconds\n- `w` for weeks\n\nFor example, `24h`, to mean query data starting from 24 hours ago to now." }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, { "in": "query", "name": "full", "schema": { "type": "boolean", "default": false }, "description": "Specify true to include the full event body, including the stacktrace, in the event payload." }, { "in": "query", "name": "sample", "schema": { "type": "boolean", "default": false }, "description": "Return events in pseudo-random order. This is deterministic so an identical query will always return the same events in the same order." } ], "tags": [ "Events" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "event.type": { "type": "string" }, "groupID": { "type": "string", "nullable": true }, "eventID": { "type": "string" }, "projectID": { "type": "string" }, "message": { "type": "string" }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "culprit": { "type": "string", "nullable": true }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "geo": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "nullable": true }, "tags": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "crashFile": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "crashFile", "culprit", "dateCreated", "event.type", "eventID", "groupID", "id", "location", "message", "metadata", "platform", "projectID", "tags", "title", "user" ] } }, "examples": { "ReturnAListOfErrorEventsBoundToAProject": { "value": [ { "eventID": "9fac2ceed9344f2bbfdd1fdacb0ed9b1", "tags": [ { "key": "browser", "value": "Chrome 60.0" }, { "key": "device", "value": "Other" }, { "key": "environment", "value": "production" }, { "value": "fatal", "key": "level" }, { "key": "os", "value": "Mac OS X 10.12.6" }, { "value": "CPython 2.7.16", "key": "runtime" }, { "key": "release", "value": "17642328ead24b51867165985996d04b29310337" }, { "key": "server_name", "value": "web1.example.com" } ], "dateCreated": "2020-09-11T17:46:36Z", "user": null, "message": "", "title": "This is an example Python exception", "id": "dfb1a2d057194e76a4186cc8a5271553", "platform": "python", "event.type": "error", "groupID": "1889724436", "crashFile": null, "location": "example.py:123", "culprit": "/books/new/", "projectID": "49271", "metadata": null } ], "summary": "Return a list of error events bound to a project" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/source-map-debug/": { "get": { "operationId": "Debug Issues Related to Source Maps for a Given Event", "description": "Return a list of source map errors for a given event.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "event_id", "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the event.", "required": true }, { "in": "query", "name": "frame_idx", "schema": { "type": "integer" }, "description": "Index of the frame that should be used for source map resolution.", "required": true }, { "in": "query", "name": "exception_idx", "schema": { "type": "integer" }, "description": "Index of the exception that should be used for source map resolution.", "required": true } ], "tags": [ "Events" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "data", "message", "type" ] } } }, "required": [ "errors" ] } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/filters/": { "get": { "operationId": "List a Project's Data Filters", "description": "Retrieve a list of filters for a given project.\n`active` will be either a boolean or a list for the legacy browser filters.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "active", "id" ] } }, "examples": { "ListAProject'sFilters": { "value": [ { "id": "browser-extensions", "active": false }, { "id": "filtered-transaction", "active": true }, { "id": "legacy-browsers", "active": [ "opera", "edge", "safari", "chrome", "ie", "opera_mini", "firefox", "android" ] }, { "id": "localhost", "active": false }, { "id": "web-crawlers", "active": true } ], "summary": "List a project's filters" } } } }, "description": "" }, "403": { "description": "Forbidden" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/filters/{filter_id}/": { "put": { "operationId": "Update an Inbound Data Filter", "description": "Update various inbound data filters for a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "filter_id", "schema": { "type": "string" }, "description": "The type of filter toggle to update. The options are:\n- `browser-extensions` - Filter out errors known to be caused by browser extensions.\n- `localhost` - Filter out events coming from localhost. This applies to both IPv4 (``127.0.0.1``)\nand IPv6 (``::1``) addresses.\n- `filtered-transaction` - Filter out transactions for healthcheck and ping endpoints.\n- `web-crawlers` - Filter out known web crawlers. Some crawlers may execute pages in incompatible\nways which cause errors that are unlikely to be seen by a normal user.\n- `legacy-browser` - Filter out known errors from legacy browsers. Older browsers often give less\naccurate information, and while they may report valid issues, the context to understand them is\nincorrect or missing.\n", "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Toggle the browser-extensions, localhost, filtered-transaction, or web-crawlers filter on or off." }, "subfilters": { "type": "array", "items": { "enum": [ "ie", "edge", "safari", "firefox", "chrome", "opera", "android", "opera_mini", "ie_pre_9", "ie9", "ie10", "ie11", "opera_pre_15", "android_pre_4", "safari_pre_6", "opera_mini_pre_8", "edge_pre_79" ], "type": "string", "description": "* `ie`\n* `edge`\n* `safari`\n* `firefox`\n* `chrome`\n* `opera`\n* `android`\n* `opera_mini`\n* `ie_pre_9`\n* `ie9`\n* `ie10`\n* `ie11`\n* `opera_pre_15`\n* `android_pre_4`\n* `safari_pre_6`\n* `opera_mini_pre_8`\n* `edge_pre_79`" }, "description": "\nSpecifies which legacy browser filters should be active. Anything excluded from the list will be\ndisabled. The options are:\n- `ie` - Internet Explorer Version 11 and lower\n- `edge` - Edge Version 110 and lower\n- `safari` - Safari Version 15 and lower\n- `firefox` - Firefox Version 110 and lower\n- `chrome` - Chrome Version 110 and lower\n- `opera` - Opera Version 99 and lower\n- `android` - Android Version 3 and lower\n- `opera_mini` - Opera Mini Version 34 and lower\n\nDeprecated options:\n- `ie_pre_9` - Internet Explorer Version 8 and lower\n- `ie9` - Internet Explorer Version 9\n- `ie10` - Internet Explorer Version 10\n- `ie11` - Internet Explorer Version 11\n- `safari_pre_6` - Safari Version 5 and lower\n- `opera_pre_15` - Opera Version 14 and lower\n- `opera_mini_pre_8` - Opera Mini Version 8 and lower\n- `android_pre_4` - Android Version 3 and lower\n- `edge_pre_79` - Edge Version 18 and lower (non Chromium based)\n" } } } } } }, "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/keys/": { "get": { "operationId": "List a Project's Client Keys", "description": "Return a list of client keys bound to a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, { "in": "query", "name": "status", "schema": { "type": "string" }, "description": "\nFilter client keys by `active` or `inactive`. Defaults to returning all\nkeys if not specified.\n" } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "This represents a Sentry Project Client Key.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "public": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "projectId": { "type": "integer" }, "isActive": { "type": "boolean" }, "rateLimit": { "type": "object", "properties": { "window": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "count", "window" ], "nullable": true }, "dsn": { "type": "object", "properties": { "secret": { "type": "string" }, "public": { "type": "string" }, "csp": { "type": "string" }, "security": { "type": "string" }, "minidump": { "type": "string" }, "nel": { "type": "string" }, "unreal": { "type": "string" }, "crons": { "type": "string" }, "cdn": { "type": "string" }, "playstation": { "type": "string" }, "integration": { "type": "string" }, "otlp_traces": { "type": "string" }, "otlp_logs": { "type": "string" } }, "required": [ "cdn", "crons", "csp", "integration", "minidump", "nel", "otlp_logs", "otlp_traces", "playstation", "public", "secret", "security", "unreal" ] }, "browserSdkVersion": { "type": "string" }, "browserSdk": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "choices" ] }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dynamicSdkLoaderOptions": { "type": "object", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } }, "required": [ "hasDebug", "hasFeedback", "hasLogsAndMetrics", "hasPerformance", "hasReplay" ] }, "useCase": { "type": "string" } }, "required": [ "browserSdk", "browserSdkVersion", "dateCreated", "dsn", "dynamicSdkLoaderOptions", "id", "isActive", "label", "name", "projectId", "public", "rateLimit", "secret" ] } }, "examples": { "ListClientKeysForAProject": { "value": [ { "id": "60120449b6b1d5e45f75561e6dabd80b", "name": "Liked Pegasus", "label": "Liked Pegasus", "public": "60120449b6b1d5e45f75561e6dabd80b", "secret": "189485c3b8ccf582bf5e12c530ef8858", "projectId": 4505281256090153, "isActive": true, "rateLimit": { "window": 7200, "count": 1000 }, "dsn": { "secret": "https://a785682ddda742d7a8a4088810e67701:bcd99b3790b3441c85ce4b1eaa854f66@o4504765715316736.ingest.sentry.io/4505281256090153", "public": "https://a785682ddda742d7a8a4088810e67791@o4504765715316736.ingest.sentry.io/4505281256090153", "csp": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/csp-report/?sentry_key=a785682ddda719b7a8a4011110d75598", "security": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/security/?sentry_key=a785682ddda719b7a8a4011110d75598", "minidump": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/minidump/?sentry_key=a785682ddda719b7a8a4011110d75598", "playstation": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/playstation/?sentry_key=a785682ddda719b7a8a4011110d75598", "integration": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/", "otlp_traces": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/traces", "otlp_logs": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/logs", "nel": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/nel/?sentry_key=a785682ddda719b7a8a4011110d75598", "unreal": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/unreal/a785682ddda719b7a8a4011110d75598/", "cdn": "https://js.sentry-cdn.com/a785682ddda719b7a8a4011110d75598.min.js", "crons": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/crons/___MONITOR_SLUG___/a785682ddda719b7a8a4011110d75598/" }, "browserSdkVersion": "7.x", "browserSdk": { "choices": [ [ "latest", "latest" ], [ "7.x", "7.x" ] ] }, "dateCreated": "2023-06-21T19:50:26.036254Z", "dynamicSdkLoaderOptions": { "hasReplay": true, "hasPerformance": true, "hasDebug": true, "hasFeedback": false, "hasLogsAndMetrics": false } }, { "id": "da8d69cb17e80677b76e08fde4656b93", "name": "Bold Oarfish", "label": "Bold Oarfish", "public": "da8d69cb17e80677b76e08fde4656b93", "secret": "5c241ebc42ccfbec281cbefbedc7ab96", "projectId": 4505281256090153, "isActive": true, "rateLimit": null, "dsn": { "secret": "https://a785682ddda742d7a8a4088810e67701:bcd99b3790b3441c85ce4b1eaa854f66@o4504765715316736.ingest.sentry.io/4505281256090153", "public": "https://a785682ddda742d7a8a4088810e67791@o4504765715316736.ingest.sentry.io/4505281256090153", "csp": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/csp-report/?sentry_key=a785682ddda719b7a8a4011110d75598", "security": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/security/?sentry_key=a785682ddda719b7a8a4011110d75598", "minidump": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/minidump/?sentry_key=a785682ddda719b7a8a4011110d75598", "playstation": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/playstation/?sentry_key=a785682ddda719b7a8a4011110d75598", "integration": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/", "otlp_traces": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/traces", "otlp_logs": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/logs", "nel": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/nel/?sentry_key=a785682ddda719b7a8a4011110d75598", "unreal": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/unreal/a785682ddda719b7a8a4011110d75598/", "cdn": "https://js.sentry-cdn.com/a785682ddda719b7a8a4011110d75598.min.js", "crons": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/crons/___MONITOR_SLUG___/a785682ddda719b7a8a4011110d75598/" }, "browserSdkVersion": "7.x", "browserSdk": { "choices": [ [ "latest", "latest" ], [ "7.x", "7.x" ] ] }, "dateCreated": "2023-06-21T19:50:26.036254Z", "dynamicSdkLoaderOptions": { "hasReplay": true, "hasPerformance": true, "hasDebug": true, "hasFeedback": false, "hasLogsAndMetrics": false } } ], "summary": "List Client Keys for a Project" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } }, "post": { "operationId": "Create a New Client Key", "description": "Create a new client key bound to a project. The key's secret and public key\nare generated by the server.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "The optional name of the key. If not provided it will be automatically generated.", "maxLength": 64 }, "rateLimit": { "type": "object", "description": "Applies a rate limit to cap the number of errors accepted during a given time window. To\ndisable entirely set `rateLimit` to null.\n```json\n{\n \"rateLimit\": {\n \"window\": 7200, // time in seconds\n \"count\": 1000 // error cap\n }\n}\n```", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "window": { "type": "integer", "maximum": 86400, "minimum": 0, "nullable": true } } }, "useCase": { "enum": [ "user", "profiling", "tempest", "demo" ], "type": "string", "description": "* `user`\n* `profiling`\n* `tempest`\n* `demo`", "default": "user" } } } } } }, "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "description": "This represents a Sentry Project Client Key.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "public": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "projectId": { "type": "integer" }, "isActive": { "type": "boolean" }, "rateLimit": { "type": "object", "properties": { "window": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "count", "window" ], "nullable": true }, "dsn": { "type": "object", "properties": { "secret": { "type": "string" }, "public": { "type": "string" }, "csp": { "type": "string" }, "security": { "type": "string" }, "minidump": { "type": "string" }, "nel": { "type": "string" }, "unreal": { "type": "string" }, "crons": { "type": "string" }, "cdn": { "type": "string" }, "playstation": { "type": "string" }, "integration": { "type": "string" }, "otlp_traces": { "type": "string" }, "otlp_logs": { "type": "string" } }, "required": [ "cdn", "crons", "csp", "integration", "minidump", "nel", "otlp_logs", "otlp_traces", "playstation", "public", "secret", "security", "unreal" ] }, "browserSdkVersion": { "type": "string" }, "browserSdk": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "choices" ] }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dynamicSdkLoaderOptions": { "type": "object", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } }, "required": [ "hasDebug", "hasFeedback", "hasLogsAndMetrics", "hasPerformance", "hasReplay" ] }, "useCase": { "type": "string" } }, "required": [ "browserSdk", "browserSdkVersion", "dateCreated", "dsn", "dynamicSdkLoaderOptions", "id", "isActive", "label", "name", "projectId", "public", "rateLimit", "secret" ] }, "examples": { "ClientKeyWithRateLimiting": { "value": { "id": "60120449b6b1d5e45f75561e6dabd80b", "name": "Liked Pegasus", "label": "Liked Pegasus", "public": "60120449b6b1d5e45f75561e6dabd80b", "secret": "189485c3b8ccf582bf5e12c530ef8858", "projectId": 4505281256090153, "isActive": true, "rateLimit": { "window": 7200, "count": 1000 }, "dsn": { "secret": "https://a785682ddda742d7a8a4088810e67701:bcd99b3790b3441c85ce4b1eaa854f66@o4504765715316736.ingest.sentry.io/4505281256090153", "public": "https://a785682ddda742d7a8a4088810e67791@o4504765715316736.ingest.sentry.io/4505281256090153", "csp": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/csp-report/?sentry_key=a785682ddda719b7a8a4011110d75598", "security": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/security/?sentry_key=a785682ddda719b7a8a4011110d75598", "minidump": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/minidump/?sentry_key=a785682ddda719b7a8a4011110d75598", "playstation": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/playstation/?sentry_key=a785682ddda719b7a8a4011110d75598", "integration": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/", "otlp_traces": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/traces", "otlp_logs": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/logs", "nel": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/nel/?sentry_key=a785682ddda719b7a8a4011110d75598", "unreal": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/unreal/a785682ddda719b7a8a4011110d75598/", "cdn": "https://js.sentry-cdn.com/a785682ddda719b7a8a4011110d75598.min.js", "crons": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/crons/___MONITOR_SLUG___/a785682ddda719b7a8a4011110d75598/" }, "browserSdkVersion": "7.x", "browserSdk": { "choices": [ [ "latest", "latest" ], [ "7.x", "7.x" ] ] }, "dateCreated": "2023-06-21T19:50:26.036254Z", "dynamicSdkLoaderOptions": { "hasReplay": true, "hasPerformance": true, "hasDebug": true, "hasFeedback": false, "hasLogsAndMetrics": false } }, "summary": "Client key with rate limiting" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/keys/{key_id}/": { "get": { "operationId": "Retrieve a Client Key", "description": "Return a client key bound to a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "key_id", "schema": { "type": "string" }, "description": "The ID of the client key", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "This represents a Sentry Project Client Key.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "public": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "projectId": { "type": "integer" }, "isActive": { "type": "boolean" }, "rateLimit": { "type": "object", "properties": { "window": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "count", "window" ], "nullable": true }, "dsn": { "type": "object", "properties": { "secret": { "type": "string" }, "public": { "type": "string" }, "csp": { "type": "string" }, "security": { "type": "string" }, "minidump": { "type": "string" }, "nel": { "type": "string" }, "unreal": { "type": "string" }, "crons": { "type": "string" }, "cdn": { "type": "string" }, "playstation": { "type": "string" }, "integration": { "type": "string" }, "otlp_traces": { "type": "string" }, "otlp_logs": { "type": "string" } }, "required": [ "cdn", "crons", "csp", "integration", "minidump", "nel", "otlp_logs", "otlp_traces", "playstation", "public", "secret", "security", "unreal" ] }, "browserSdkVersion": { "type": "string" }, "browserSdk": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "choices" ] }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dynamicSdkLoaderOptions": { "type": "object", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } }, "required": [ "hasDebug", "hasFeedback", "hasLogsAndMetrics", "hasPerformance", "hasReplay" ] }, "useCase": { "type": "string" } }, "required": [ "browserSdk", "browserSdkVersion", "dateCreated", "dsn", "dynamicSdkLoaderOptions", "id", "isActive", "label", "name", "projectId", "public", "rateLimit", "secret" ] }, "examples": { "ClientKeyWithRateLimiting": { "value": { "id": "60120449b6b1d5e45f75561e6dabd80b", "name": "Liked Pegasus", "label": "Liked Pegasus", "public": "60120449b6b1d5e45f75561e6dabd80b", "secret": "189485c3b8ccf582bf5e12c530ef8858", "projectId": 4505281256090153, "isActive": true, "rateLimit": { "window": 7200, "count": 1000 }, "dsn": { "secret": "https://a785682ddda742d7a8a4088810e67701:bcd99b3790b3441c85ce4b1eaa854f66@o4504765715316736.ingest.sentry.io/4505281256090153", "public": "https://a785682ddda742d7a8a4088810e67791@o4504765715316736.ingest.sentry.io/4505281256090153", "csp": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/csp-report/?sentry_key=a785682ddda719b7a8a4011110d75598", "security": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/security/?sentry_key=a785682ddda719b7a8a4011110d75598", "minidump": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/minidump/?sentry_key=a785682ddda719b7a8a4011110d75598", "playstation": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/playstation/?sentry_key=a785682ddda719b7a8a4011110d75598", "integration": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/", "otlp_traces": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/traces", "otlp_logs": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/logs", "nel": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/nel/?sentry_key=a785682ddda719b7a8a4011110d75598", "unreal": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/unreal/a785682ddda719b7a8a4011110d75598/", "cdn": "https://js.sentry-cdn.com/a785682ddda719b7a8a4011110d75598.min.js", "crons": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/crons/___MONITOR_SLUG___/a785682ddda719b7a8a4011110d75598/" }, "browserSdkVersion": "7.x", "browserSdk": { "choices": [ [ "latest", "latest" ], [ "7.x", "7.x" ] ] }, "dateCreated": "2023-06-21T19:50:26.036254Z", "dynamicSdkLoaderOptions": { "hasReplay": true, "hasPerformance": true, "hasDebug": true, "hasFeedback": false, "hasLogsAndMetrics": false } }, "summary": "Client key with rate limiting" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update a Client Key", "description": "Update various settings for a client key.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "key_id", "schema": { "type": "string" }, "description": "The ID of the key to update.", "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for the client key" }, "isActive": { "type": "boolean", "description": "Activate or deactivate the client key." }, "rateLimit": { "type": "object", "description": "Applies a rate limit to cap the number of errors accepted during a given time window. To\ndisable entirely set `rateLimit` to null.\n```json\n{\n \"rateLimit\": {\n \"window\": 7200, // time in seconds\n \"count\": 1000 // error cap\n }\n}\n```", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "window": { "type": "integer", "maximum": 86400, "minimum": 0, "nullable": true } } }, "browserSdkVersion": { "enum": [ "latest", "7.x" ], "type": "string", "description": "The Sentry Javascript SDK version to use. The currently supported options are:\n\n* `latest` - Most recent version\n* `7.x` - Version 7 releases" }, "dynamicSdkLoaderOptions": { "type": "object", "description": "Configures multiple options for the Javascript Loader Script.\n- `Performance Monitoring`\n- `Debug Bundles & Logging`\n- `Session Replay` - Note that the loader will load the ES6 bundle instead of the ES5 bundle.\n- `User Feedback` - Note that the loader will load the ES6 bundle instead of the ES5 bundle.\n- `Logs and Metrics` - Note that the loader will load the ES6 bundle instead of the ES5 bundle. Requires SDK >= 10.0.0.\n```json\n{\n \"dynamicSdkLoaderOptions\": {\n \"hasReplay\": true,\n \"hasPerformance\": true,\n \"hasDebug\": true,\n \"hasFeedback\": true,\n \"hasLogsAndMetrics\": true\n }\n}\n```", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } } } } } } } }, "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "This represents a Sentry Project Client Key.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "public": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "projectId": { "type": "integer" }, "isActive": { "type": "boolean" }, "rateLimit": { "type": "object", "properties": { "window": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "count", "window" ], "nullable": true }, "dsn": { "type": "object", "properties": { "secret": { "type": "string" }, "public": { "type": "string" }, "csp": { "type": "string" }, "security": { "type": "string" }, "minidump": { "type": "string" }, "nel": { "type": "string" }, "unreal": { "type": "string" }, "crons": { "type": "string" }, "cdn": { "type": "string" }, "playstation": { "type": "string" }, "integration": { "type": "string" }, "otlp_traces": { "type": "string" }, "otlp_logs": { "type": "string" } }, "required": [ "cdn", "crons", "csp", "integration", "minidump", "nel", "otlp_logs", "otlp_traces", "playstation", "public", "secret", "security", "unreal" ] }, "browserSdkVersion": { "type": "string" }, "browserSdk": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "choices" ] }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dynamicSdkLoaderOptions": { "type": "object", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } }, "required": [ "hasDebug", "hasFeedback", "hasLogsAndMetrics", "hasPerformance", "hasReplay" ] }, "useCase": { "type": "string" } }, "required": [ "browserSdk", "browserSdkVersion", "dateCreated", "dsn", "dynamicSdkLoaderOptions", "id", "isActive", "label", "name", "projectId", "public", "rateLimit", "secret" ] }, "examples": { "ClientKeyWithRateLimiting": { "value": { "id": "60120449b6b1d5e45f75561e6dabd80b", "name": "Liked Pegasus", "label": "Liked Pegasus", "public": "60120449b6b1d5e45f75561e6dabd80b", "secret": "189485c3b8ccf582bf5e12c530ef8858", "projectId": 4505281256090153, "isActive": true, "rateLimit": { "window": 7200, "count": 1000 }, "dsn": { "secret": "https://a785682ddda742d7a8a4088810e67701:bcd99b3790b3441c85ce4b1eaa854f66@o4504765715316736.ingest.sentry.io/4505281256090153", "public": "https://a785682ddda742d7a8a4088810e67791@o4504765715316736.ingest.sentry.io/4505281256090153", "csp": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/csp-report/?sentry_key=a785682ddda719b7a8a4011110d75598", "security": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/security/?sentry_key=a785682ddda719b7a8a4011110d75598", "minidump": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/minidump/?sentry_key=a785682ddda719b7a8a4011110d75598", "playstation": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/playstation/?sentry_key=a785682ddda719b7a8a4011110d75598", "integration": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/", "otlp_traces": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/traces", "otlp_logs": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/integration/otlp/v1/logs", "nel": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/nel/?sentry_key=a785682ddda719b7a8a4011110d75598", "unreal": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/unreal/a785682ddda719b7a8a4011110d75598/", "cdn": "https://js.sentry-cdn.com/a785682ddda719b7a8a4011110d75598.min.js", "crons": "https://o4504765715316736.ingest.sentry.io/api/4505281256090153/crons/___MONITOR_SLUG___/a785682ddda719b7a8a4011110d75598/" }, "browserSdkVersion": "7.x", "browserSdk": { "choices": [ [ "latest", "latest" ], [ "7.x", "7.x" ] ] }, "dateCreated": "2023-06-21T19:50:26.036254Z", "dynamicSdkLoaderOptions": { "hasReplay": true, "hasPerformance": true, "hasDebug": true, "hasFeedback": false, "hasLogsAndMetrics": false } }, "summary": "Client key with rate limiting" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete a Client Key", "description": "Delete a client key for a given project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "key_id", "schema": { "type": "string" }, "description": "The ID of the key to delete.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/members/": { "get": { "operationId": "List a Project's Organization Members", "description": "Returns a list of active organization members that belong to any team assigned to the project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "inviterName", "name", "orgRole", "pending" ] } }, "examples": { "ListOrganizationMembers": { "value": [ { "id": "57377908164", "email": "sirpenguin@antarcticarocks.com", "name": "Sir Penguin", "user": { "id": "280094367316", "name": "Sir Penguin", "username": "sirpenguin@antarcticarocks.com", "email": "sirpenguin@antarcticarocks.com", "avatarUrl": "https://secure.gravatar.com/avatar/16aeb26c5fdba335c7078e9e9ddb5149?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-07-06T21:13:58.375239Z", "lastLogin": "2021-08-02T18:25:00.051182Z", "has2fa": false, "lastActive": "2021-08-02T21:32:18.836829Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "2153450836", "email": "sirpenguin@antarcticarocks.com", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "canReset2fa": true }, "orgRole": "member", "pending": false, "expired": false, "flags": { "idp:provisioned": false, "idp:role-restricted": false, "sso:linked": false, "sso:invalid": false, "member-limit:restricted": false, "partnership:restricted": false }, "dateCreated": "2021-07-06T21:13:01.120263Z", "inviteStatus": "approved", "inviterName": "maininviter@antarcticarocks.com" }, { "id": "57377908165", "email": "rockhopper@antarcticarocks.com", "name": "Rockhopper", "orgRole": "member", "pending": true, "expired": false, "flags": { "idp:provisioned": false, "idp:role-restricted": false, "sso:linked": false, "sso:invalid": false, "member-limit:restricted": false, "partnership:restricted": false }, "dateCreated": "2021-07-07T21:13:01.120263Z", "inviteStatus": "pending", "inviterName": "maininviter@antarcticarocks.com" } ], "summary": "List organization members" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/monitors/{monitor_id_or_slug}/": { "get": { "operationId": "Retrieve a Monitor for a Project", "description": "Retrieves details for a monitor.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "monitor_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the monitor.", "required": true } ], "tags": [ "Crons" ], "security": [ { "auth_token": [ "alerts:read", "alerts:write", "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "alertRule": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "targetIdentifier": { "type": "integer" }, "targetType": { "type": "string" } }, "required": [ "targetIdentifier", "targetType" ] } }, "environment": { "type": "string" } }, "required": [ "environment", "targets" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "isUpserting": { "type": "boolean" }, "config": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] }, "environments": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastCheckIn": { "type": "string", "format": "date-time" }, "nextCheckIn": { "type": "string", "format": "date-time" }, "nextCheckInLatest": { "type": "string", "format": "date-time" }, "activeIncident": { "type": "object", "properties": { "startingTimestamp": { "type": "string", "format": "date-time" }, "resolvingTimestamp": { "type": "string", "format": "date-time" }, "brokenNotice": { "type": "object", "properties": { "userNotifiedTimestamp": { "type": "string", "format": "date-time" }, "environmentMutedTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "environmentMutedTimestamp", "userNotifiedTimestamp" ], "nullable": true } }, "required": [ "brokenNotice", "resolvingTimestamp", "startingTimestamp" ], "nullable": true } }, "required": [ "activeIncident", "dateCreated", "isMuted", "lastCheckIn", "name", "nextCheckIn", "nextCheckInLatest", "status" ] }, "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] } }, "required": [ "config", "dateCreated", "environments", "id", "isMuted", "isUpserting", "name", "owner", "project", "slug", "status" ] } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update a Monitor for a Project", "description": "Update a monitor.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "monitor_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the monitor.", "required": true } ], "tags": [ "Crons" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "project": { "type": "string", "description": "The project slug to associate the monitor to." }, "name": { "type": "string", "description": "Name of the monitor. Used for notifications. If not set the slug will be derived from your monitor name.", "maxLength": 128 }, "config": { "allOf": [ { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string", "description": "Currently supports \"crontab\" or \"interval\"\n\n* `crontab`\n* `interval`" }, "schedule": { "description": "Varies depending on the schedule_type. Is either a crontab string, or a 2 element tuple for intervals (e.g. [1, 'day'])" }, "checkin_margin": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) after the expected checkin time will we wait until we consider the checkin to have been missed." }, "max_runtime": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) is the checkin allowed to run for in CheckInStatus.IN_PROGRESS before it is considered failed." }, "timezone": { "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "localtime", "" ], "type": "string", "description": "tz database style timezone string\n\n* `Africa/Abidjan`\n* `Africa/Accra`\n* `Africa/Addis_Ababa`\n* `Africa/Algiers`\n* `Africa/Asmara`\n* `Africa/Asmera`\n* `Africa/Bamako`\n* `Africa/Bangui`\n* `Africa/Banjul`\n* `Africa/Bissau`\n* `Africa/Blantyre`\n* `Africa/Brazzaville`\n* `Africa/Bujumbura`\n* `Africa/Cairo`\n* `Africa/Casablanca`\n* `Africa/Ceuta`\n* `Africa/Conakry`\n* `Africa/Dakar`\n* `Africa/Dar_es_Salaam`\n* `Africa/Djibouti`\n* `Africa/Douala`\n* `Africa/El_Aaiun`\n* `Africa/Freetown`\n* `Africa/Gaborone`\n* `Africa/Harare`\n* `Africa/Johannesburg`\n* `Africa/Juba`\n* `Africa/Kampala`\n* `Africa/Khartoum`\n* `Africa/Kigali`\n* `Africa/Kinshasa`\n* `Africa/Lagos`\n* `Africa/Libreville`\n* `Africa/Lome`\n* `Africa/Luanda`\n* `Africa/Lubumbashi`\n* `Africa/Lusaka`\n* `Africa/Malabo`\n* `Africa/Maputo`\n* `Africa/Maseru`\n* `Africa/Mbabane`\n* `Africa/Mogadishu`\n* `Africa/Monrovia`\n* `Africa/Nairobi`\n* `Africa/Ndjamena`\n* `Africa/Niamey`\n* `Africa/Nouakchott`\n* `Africa/Ouagadougou`\n* `Africa/Porto-Novo`\n* `Africa/Sao_Tome`\n* `Africa/Timbuktu`\n* `Africa/Tripoli`\n* `Africa/Tunis`\n* `Africa/Windhoek`\n* `America/Adak`\n* `America/Anchorage`\n* `America/Anguilla`\n* `America/Antigua`\n* `America/Araguaina`\n* `America/Argentina/Buenos_Aires`\n* `America/Argentina/Catamarca`\n* `America/Argentina/ComodRivadavia`\n* `America/Argentina/Cordoba`\n* `America/Argentina/Jujuy`\n* `America/Argentina/La_Rioja`\n* `America/Argentina/Mendoza`\n* `America/Argentina/Rio_Gallegos`\n* `America/Argentina/Salta`\n* `America/Argentina/San_Juan`\n* `America/Argentina/San_Luis`\n* `America/Argentina/Tucuman`\n* `America/Argentina/Ushuaia`\n* `America/Aruba`\n* `America/Asuncion`\n* `America/Atikokan`\n* `America/Atka`\n* `America/Bahia`\n* `America/Bahia_Banderas`\n* `America/Barbados`\n* `America/Belem`\n* `America/Belize`\n* `America/Blanc-Sablon`\n* `America/Boa_Vista`\n* `America/Bogota`\n* `America/Boise`\n* `America/Buenos_Aires`\n* `America/Cambridge_Bay`\n* `America/Campo_Grande`\n* `America/Cancun`\n* `America/Caracas`\n* `America/Catamarca`\n* `America/Cayenne`\n* `America/Cayman`\n* `America/Chicago`\n* `America/Chihuahua`\n* `America/Ciudad_Juarez`\n* `America/Coral_Harbour`\n* `America/Cordoba`\n* `America/Costa_Rica`\n* `America/Coyhaique`\n* `America/Creston`\n* `America/Cuiaba`\n* `America/Curacao`\n* `America/Danmarkshavn`\n* `America/Dawson`\n* `America/Dawson_Creek`\n* `America/Denver`\n* `America/Detroit`\n* `America/Dominica`\n* `America/Edmonton`\n* `America/Eirunepe`\n* `America/El_Salvador`\n* `America/Ensenada`\n* `America/Fort_Nelson`\n* `America/Fort_Wayne`\n* `America/Fortaleza`\n* `America/Glace_Bay`\n* `America/Godthab`\n* `America/Goose_Bay`\n* `America/Grand_Turk`\n* `America/Grenada`\n* `America/Guadeloupe`\n* `America/Guatemala`\n* `America/Guayaquil`\n* `America/Guyana`\n* `America/Halifax`\n* `America/Havana`\n* `America/Hermosillo`\n* `America/Indiana/Indianapolis`\n* `America/Indiana/Knox`\n* `America/Indiana/Marengo`\n* `America/Indiana/Petersburg`\n* `America/Indiana/Tell_City`\n* `America/Indiana/Vevay`\n* `America/Indiana/Vincennes`\n* `America/Indiana/Winamac`\n* `America/Indianapolis`\n* `America/Inuvik`\n* `America/Iqaluit`\n* `America/Jamaica`\n* `America/Jujuy`\n* `America/Juneau`\n* `America/Kentucky/Louisville`\n* `America/Kentucky/Monticello`\n* `America/Knox_IN`\n* `America/Kralendijk`\n* `America/La_Paz`\n* `America/Lima`\n* `America/Los_Angeles`\n* `America/Louisville`\n* `America/Lower_Princes`\n* `America/Maceio`\n* `America/Managua`\n* `America/Manaus`\n* `America/Marigot`\n* `America/Martinique`\n* `America/Matamoros`\n* `America/Mazatlan`\n* `America/Mendoza`\n* `America/Menominee`\n* `America/Merida`\n* `America/Metlakatla`\n* `America/Mexico_City`\n* `America/Miquelon`\n* `America/Moncton`\n* `America/Monterrey`\n* `America/Montevideo`\n* `America/Montreal`\n* `America/Montserrat`\n* `America/Nassau`\n* `America/New_York`\n* `America/Nipigon`\n* `America/Nome`\n* `America/Noronha`\n* `America/North_Dakota/Beulah`\n* `America/North_Dakota/Center`\n* `America/North_Dakota/New_Salem`\n* `America/Nuuk`\n* `America/Ojinaga`\n* `America/Panama`\n* `America/Pangnirtung`\n* `America/Paramaribo`\n* `America/Phoenix`\n* `America/Port-au-Prince`\n* `America/Port_of_Spain`\n* `America/Porto_Acre`\n* `America/Porto_Velho`\n* `America/Puerto_Rico`\n* `America/Punta_Arenas`\n* `America/Rainy_River`\n* `America/Rankin_Inlet`\n* `America/Recife`\n* `America/Regina`\n* `America/Resolute`\n* `America/Rio_Branco`\n* `America/Rosario`\n* `America/Santa_Isabel`\n* `America/Santarem`\n* `America/Santiago`\n* `America/Santo_Domingo`\n* `America/Sao_Paulo`\n* `America/Scoresbysund`\n* `America/Shiprock`\n* `America/Sitka`\n* `America/St_Barthelemy`\n* `America/St_Johns`\n* `America/St_Kitts`\n* `America/St_Lucia`\n* `America/St_Thomas`\n* `America/St_Vincent`\n* `America/Swift_Current`\n* `America/Tegucigalpa`\n* `America/Thule`\n* `America/Thunder_Bay`\n* `America/Tijuana`\n* `America/Toronto`\n* `America/Tortola`\n* `America/Vancouver`\n* `America/Virgin`\n* `America/Whitehorse`\n* `America/Winnipeg`\n* `America/Yakutat`\n* `America/Yellowknife`\n* `Antarctica/Casey`\n* `Antarctica/Davis`\n* `Antarctica/DumontDUrville`\n* `Antarctica/Macquarie`\n* `Antarctica/Mawson`\n* `Antarctica/McMurdo`\n* `Antarctica/Palmer`\n* `Antarctica/Rothera`\n* `Antarctica/South_Pole`\n* `Antarctica/Syowa`\n* `Antarctica/Troll`\n* `Antarctica/Vostok`\n* `Arctic/Longyearbyen`\n* `Asia/Aden`\n* `Asia/Almaty`\n* `Asia/Amman`\n* `Asia/Anadyr`\n* `Asia/Aqtau`\n* `Asia/Aqtobe`\n* `Asia/Ashgabat`\n* `Asia/Ashkhabad`\n* `Asia/Atyrau`\n* `Asia/Baghdad`\n* `Asia/Bahrain`\n* `Asia/Baku`\n* `Asia/Bangkok`\n* `Asia/Barnaul`\n* `Asia/Beirut`\n* `Asia/Bishkek`\n* `Asia/Brunei`\n* `Asia/Calcutta`\n* `Asia/Chita`\n* `Asia/Choibalsan`\n* `Asia/Chongqing`\n* `Asia/Chungking`\n* `Asia/Colombo`\n* `Asia/Dacca`\n* `Asia/Damascus`\n* `Asia/Dhaka`\n* `Asia/Dili`\n* `Asia/Dubai`\n* `Asia/Dushanbe`\n* `Asia/Famagusta`\n* `Asia/Gaza`\n* `Asia/Harbin`\n* `Asia/Hebron`\n* `Asia/Ho_Chi_Minh`\n* `Asia/Hong_Kong`\n* `Asia/Hovd`\n* `Asia/Irkutsk`\n* `Asia/Istanbul`\n* `Asia/Jakarta`\n* `Asia/Jayapura`\n* `Asia/Jerusalem`\n* `Asia/Kabul`\n* `Asia/Kamchatka`\n* `Asia/Karachi`\n* `Asia/Kashgar`\n* `Asia/Kathmandu`\n* `Asia/Katmandu`\n* `Asia/Khandyga`\n* `Asia/Kolkata`\n* `Asia/Krasnoyarsk`\n* `Asia/Kuala_Lumpur`\n* `Asia/Kuching`\n* `Asia/Kuwait`\n* `Asia/Macao`\n* `Asia/Macau`\n* `Asia/Magadan`\n* `Asia/Makassar`\n* `Asia/Manila`\n* `Asia/Muscat`\n* `Asia/Nicosia`\n* `Asia/Novokuznetsk`\n* `Asia/Novosibirsk`\n* `Asia/Omsk`\n* `Asia/Oral`\n* `Asia/Phnom_Penh`\n* `Asia/Pontianak`\n* `Asia/Pyongyang`\n* `Asia/Qatar`\n* `Asia/Qostanay`\n* `Asia/Qyzylorda`\n* `Asia/Rangoon`\n* `Asia/Riyadh`\n* `Asia/Saigon`\n* `Asia/Sakhalin`\n* `Asia/Samarkand`\n* `Asia/Seoul`\n* `Asia/Shanghai`\n* `Asia/Singapore`\n* `Asia/Srednekolymsk`\n* `Asia/Taipei`\n* `Asia/Tashkent`\n* `Asia/Tbilisi`\n* `Asia/Tehran`\n* `Asia/Tel_Aviv`\n* `Asia/Thimbu`\n* `Asia/Thimphu`\n* `Asia/Tokyo`\n* `Asia/Tomsk`\n* `Asia/Ujung_Pandang`\n* `Asia/Ulaanbaatar`\n* `Asia/Ulan_Bator`\n* `Asia/Urumqi`\n* `Asia/Ust-Nera`\n* `Asia/Vientiane`\n* `Asia/Vladivostok`\n* `Asia/Yakutsk`\n* `Asia/Yangon`\n* `Asia/Yekaterinburg`\n* `Asia/Yerevan`\n* `Atlantic/Azores`\n* `Atlantic/Bermuda`\n* `Atlantic/Canary`\n* `Atlantic/Cape_Verde`\n* `Atlantic/Faeroe`\n* `Atlantic/Faroe`\n* `Atlantic/Jan_Mayen`\n* `Atlantic/Madeira`\n* `Atlantic/Reykjavik`\n* `Atlantic/South_Georgia`\n* `Atlantic/St_Helena`\n* `Atlantic/Stanley`\n* `Australia/ACT`\n* `Australia/Adelaide`\n* `Australia/Brisbane`\n* `Australia/Broken_Hill`\n* `Australia/Canberra`\n* `Australia/Currie`\n* `Australia/Darwin`\n* `Australia/Eucla`\n* `Australia/Hobart`\n* `Australia/LHI`\n* `Australia/Lindeman`\n* `Australia/Lord_Howe`\n* `Australia/Melbourne`\n* `Australia/NSW`\n* `Australia/North`\n* `Australia/Perth`\n* `Australia/Queensland`\n* `Australia/South`\n* `Australia/Sydney`\n* `Australia/Tasmania`\n* `Australia/Victoria`\n* `Australia/West`\n* `Australia/Yancowinna`\n* `Brazil/Acre`\n* `Brazil/DeNoronha`\n* `Brazil/East`\n* `Brazil/West`\n* `CET`\n* `CST6CDT`\n* `Canada/Atlantic`\n* `Canada/Central`\n* `Canada/Eastern`\n* `Canada/Mountain`\n* `Canada/Newfoundland`\n* `Canada/Pacific`\n* `Canada/Saskatchewan`\n* `Canada/Yukon`\n* `Chile/Continental`\n* `Chile/EasterIsland`\n* `Cuba`\n* `EET`\n* `EST`\n* `EST5EDT`\n* `Egypt`\n* `Eire`\n* `Etc/GMT`\n* `Etc/GMT+0`\n* `Etc/GMT+1`\n* `Etc/GMT+10`\n* `Etc/GMT+11`\n* `Etc/GMT+12`\n* `Etc/GMT+2`\n* `Etc/GMT+3`\n* `Etc/GMT+4`\n* `Etc/GMT+5`\n* `Etc/GMT+6`\n* `Etc/GMT+7`\n* `Etc/GMT+8`\n* `Etc/GMT+9`\n* `Etc/GMT-0`\n* `Etc/GMT-1`\n* `Etc/GMT-10`\n* `Etc/GMT-11`\n* `Etc/GMT-12`\n* `Etc/GMT-13`\n* `Etc/GMT-14`\n* `Etc/GMT-2`\n* `Etc/GMT-3`\n* `Etc/GMT-4`\n* `Etc/GMT-5`\n* `Etc/GMT-6`\n* `Etc/GMT-7`\n* `Etc/GMT-8`\n* `Etc/GMT-9`\n* `Etc/GMT0`\n* `Etc/Greenwich`\n* `Etc/UCT`\n* `Etc/UTC`\n* `Etc/Universal`\n* `Etc/Zulu`\n* `Europe/Amsterdam`\n* `Europe/Andorra`\n* `Europe/Astrakhan`\n* `Europe/Athens`\n* `Europe/Belfast`\n* `Europe/Belgrade`\n* `Europe/Berlin`\n* `Europe/Bratislava`\n* `Europe/Brussels`\n* `Europe/Bucharest`\n* `Europe/Budapest`\n* `Europe/Busingen`\n* `Europe/Chisinau`\n* `Europe/Copenhagen`\n* `Europe/Dublin`\n* `Europe/Gibraltar`\n* `Europe/Guernsey`\n* `Europe/Helsinki`\n* `Europe/Isle_of_Man`\n* `Europe/Istanbul`\n* `Europe/Jersey`\n* `Europe/Kaliningrad`\n* `Europe/Kiev`\n* `Europe/Kirov`\n* `Europe/Kyiv`\n* `Europe/Lisbon`\n* `Europe/Ljubljana`\n* `Europe/London`\n* `Europe/Luxembourg`\n* `Europe/Madrid`\n* `Europe/Malta`\n* `Europe/Mariehamn`\n* `Europe/Minsk`\n* `Europe/Monaco`\n* `Europe/Moscow`\n* `Europe/Nicosia`\n* `Europe/Oslo`\n* `Europe/Paris`\n* `Europe/Podgorica`\n* `Europe/Prague`\n* `Europe/Riga`\n* `Europe/Rome`\n* `Europe/Samara`\n* `Europe/San_Marino`\n* `Europe/Sarajevo`\n* `Europe/Saratov`\n* `Europe/Simferopol`\n* `Europe/Skopje`\n* `Europe/Sofia`\n* `Europe/Stockholm`\n* `Europe/Tallinn`\n* `Europe/Tirane`\n* `Europe/Tiraspol`\n* `Europe/Ulyanovsk`\n* `Europe/Uzhgorod`\n* `Europe/Vaduz`\n* `Europe/Vatican`\n* `Europe/Vienna`\n* `Europe/Vilnius`\n* `Europe/Volgograd`\n* `Europe/Warsaw`\n* `Europe/Zagreb`\n* `Europe/Zaporozhye`\n* `Europe/Zurich`\n* `GB`\n* `GB-Eire`\n* `GMT`\n* `GMT+0`\n* `GMT-0`\n* `GMT0`\n* `Greenwich`\n* `HST`\n* `Hongkong`\n* `Iceland`\n* `Indian/Antananarivo`\n* `Indian/Chagos`\n* `Indian/Christmas`\n* `Indian/Cocos`\n* `Indian/Comoro`\n* `Indian/Kerguelen`\n* `Indian/Mahe`\n* `Indian/Maldives`\n* `Indian/Mauritius`\n* `Indian/Mayotte`\n* `Indian/Reunion`\n* `Iran`\n* `Israel`\n* `Jamaica`\n* `Japan`\n* `Kwajalein`\n* `Libya`\n* `MET`\n* `MST`\n* `MST7MDT`\n* `Mexico/BajaNorte`\n* `Mexico/BajaSur`\n* `Mexico/General`\n* `NZ`\n* `NZ-CHAT`\n* `Navajo`\n* `PRC`\n* `PST8PDT`\n* `Pacific/Apia`\n* `Pacific/Auckland`\n* `Pacific/Bougainville`\n* `Pacific/Chatham`\n* `Pacific/Chuuk`\n* `Pacific/Easter`\n* `Pacific/Efate`\n* `Pacific/Enderbury`\n* `Pacific/Fakaofo`\n* `Pacific/Fiji`\n* `Pacific/Funafuti`\n* `Pacific/Galapagos`\n* `Pacific/Gambier`\n* `Pacific/Guadalcanal`\n* `Pacific/Guam`\n* `Pacific/Honolulu`\n* `Pacific/Johnston`\n* `Pacific/Kanton`\n* `Pacific/Kiritimati`\n* `Pacific/Kosrae`\n* `Pacific/Kwajalein`\n* `Pacific/Majuro`\n* `Pacific/Marquesas`\n* `Pacific/Midway`\n* `Pacific/Nauru`\n* `Pacific/Niue`\n* `Pacific/Norfolk`\n* `Pacific/Noumea`\n* `Pacific/Pago_Pago`\n* `Pacific/Palau`\n* `Pacific/Pitcairn`\n* `Pacific/Pohnpei`\n* `Pacific/Ponape`\n* `Pacific/Port_Moresby`\n* `Pacific/Rarotonga`\n* `Pacific/Saipan`\n* `Pacific/Samoa`\n* `Pacific/Tahiti`\n* `Pacific/Tarawa`\n* `Pacific/Tongatapu`\n* `Pacific/Truk`\n* `Pacific/Wake`\n* `Pacific/Wallis`\n* `Pacific/Yap`\n* `Poland`\n* `Portugal`\n* `ROC`\n* `ROK`\n* `Singapore`\n* `Turkey`\n* `UCT`\n* `US/Alaska`\n* `US/Aleutian`\n* `US/Arizona`\n* `US/Central`\n* `US/East-Indiana`\n* `US/Eastern`\n* `US/Hawaii`\n* `US/Indiana-Starke`\n* `US/Michigan`\n* `US/Mountain`\n* `US/Pacific`\n* `US/Samoa`\n* `UTC`\n* `Universal`\n* `W-SU`\n* `WET`\n* `Zulu`\n* `localtime`" }, "failure_issue_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many consecutive missed or failed check-ins in a row before creating a new issue." }, "recovery_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many successful check-ins in a row before resolving an issue." } }, "required": [ "schedule" ] } ], "description": "The configuration for the monitor." }, "slug": { "type": "string", "description": "Uniquely identifies your monitor within your organization. Changing this slug will require updates to any instrumented check-in calls.", "maxLength": 50, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "status": { "enum": [ "active", "disabled" ], "type": "string", "default": "active", "description": "Status of the monitor. Disabled monitors will not accept events and will not count towards the monitor quota.\n\n* `active`\n* `disabled`" }, "owner": { "type": "string", "nullable": true, "description": "The ID of the team or user that owns the monitor. (eg. user:51 or team:6)" }, "is_muted": { "type": "boolean", "description": "Disable creation of monitor incidents" } }, "required": [ "config", "name", "project" ] } } }, "required": true }, "security": [ { "auth_token": [ "alerts:write", "project:admin", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "alertRule": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "targetIdentifier": { "type": "integer" }, "targetType": { "type": "string" } }, "required": [ "targetIdentifier", "targetType" ] } }, "environment": { "type": "string" } }, "required": [ "environment", "targets" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "isUpserting": { "type": "boolean" }, "config": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] }, "environments": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastCheckIn": { "type": "string", "format": "date-time" }, "nextCheckIn": { "type": "string", "format": "date-time" }, "nextCheckInLatest": { "type": "string", "format": "date-time" }, "activeIncident": { "type": "object", "properties": { "startingTimestamp": { "type": "string", "format": "date-time" }, "resolvingTimestamp": { "type": "string", "format": "date-time" }, "brokenNotice": { "type": "object", "properties": { "userNotifiedTimestamp": { "type": "string", "format": "date-time" }, "environmentMutedTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "environmentMutedTimestamp", "userNotifiedTimestamp" ], "nullable": true } }, "required": [ "brokenNotice", "resolvingTimestamp", "startingTimestamp" ], "nullable": true } }, "required": [ "activeIncident", "dateCreated", "isMuted", "lastCheckIn", "name", "nextCheckIn", "nextCheckInLatest", "status" ] }, "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] } }, "required": [ "config", "dateCreated", "environments", "id", "isMuted", "isUpserting", "name", "owner", "project", "slug", "status" ] } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete a Monitor or Monitor Environments for a Project", "description": "Delete a monitor or monitor environments.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "monitor_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the monitor.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." } ], "tags": [ "Crons" ], "security": [ { "auth_token": [ "alerts:write", "project:admin", "project:write" ] } ], "responses": { "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/monitors/{monitor_id_or_slug}/checkins/": { "get": { "operationId": "Retrieve Check-Ins for a Monitor by Project", "description": "Retrieve a list of check-ins for a monitor", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "monitor_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the monitor.", "required": true } ], "tags": [ "Crons" ], "security": [ { "auth_token": [ "alerts:read", "alerts:write", "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "duration": { "type": "integer", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dateInProgress": { "type": "string", "format": "date-time", "nullable": true }, "dateClock": { "type": "string", "format": "date-time" }, "expectedTime": { "type": "string", "format": "date-time" }, "monitorConfig": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] } }, "required": [ "dateAdded", "dateClock", "dateCreated", "dateInProgress", "dateUpdated", "duration", "environment", "expectedTime", "id", "monitorConfig", "status" ] } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/ownership/": { "get": { "operationId": "Retrieve Ownership Configuration for a Project", "description": "Returns details on a project's ownership configuration.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schema": { "type": "object", "properties": { "$version": { "type": "integer" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "matcher": { "type": "object", "properties": { "type": { "type": "string" }, "pattern": { "type": "string" } }, "required": [ "pattern", "type" ] }, "owners": { "type": "array", "items": { "type": "object", "description": "Owner as it appears in the API response (after identifier->name rename).", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "name", "type" ] } } }, "required": [ "matcher", "owners" ] } } }, "required": [ "$version", "rules" ], "nullable": true }, "raw": { "type": "string" }, "fallthrough": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "autoAssignment": { "type": "string" }, "codeownersAutoSync": { "type": "boolean" } }, "required": [ "autoAssignment", "codeownersAutoSync", "dateCreated", "fallthrough", "isActive", "lastUpdated", "raw" ] }, "examples": { "GetOwnershipConfigurationForAProject": { "value": { "raw": "path:src/views/checkout jane.smith@org.com \nurl:https://example.com/checkout jane.smith@org.com\ntags.transaction:/checkout/:page jane.smith@org.com", "fallthrough": true, "dateCreated": "2023-10-03T20:25:18.539823Z", "lastUpdated": "2023-10-03T22:49:12.294741Z", "isActive": true, "autoAssignment": "Auto Assign to Issue Owner", "codeownersAutoSync": true, "schema": { "$version": 1, "rules": [ { "matcher": { "type": "path", "pattern": "src/views/checkout" }, "owners": [ { "type": "user", "id": "2621754", "name": "jane.smith@org.com" } ] }, { "matcher": { "type": "url", "pattern": "https://example.com/checkout" }, "owners": [ { "type": "user", "id": "2621754", "name": "jane.smith@org.com" } ] }, { "matcher": { "type": "tags.transaction", "pattern": "/checkout/:page" }, "owners": [ { "type": "user", "id": "2621754", "name": "jane.smith@org.com" } ] } ] } }, "summary": "Get ownership configuration for a project" } } } }, "description": "" } } }, "put": { "operationId": "Update Ownership Configuration for a Project", "description": "Updates ownership configurations for a project. Note that only the\nattributes submitted are modified.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "raw": { "type": "string", "description": "Raw input for ownership configuration. See the [Ownership Rules Documentation](/product/issues/ownership-rules/) to learn more." }, "fallthrough": { "type": "boolean", "description": "A boolean determining who to assign ownership to when an ownership rule has no match. If set to `True`, all project members are made owners. Otherwise, no owners are set." }, "autoAssignment": { "type": "string", "description": "Auto-assignment settings. The available options are:\n- Auto Assign to Issue Owner\n- Auto Assign to Suspect Commits\n- Turn off Auto-Assignment" }, "codeownersAutoSync": { "type": "boolean", "default": true, "description": "Set to `True` to sync issue owners with CODEOWNERS updates in a release." } } } } } }, "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "202": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schema": { "type": "object", "properties": { "$version": { "type": "integer" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "matcher": { "type": "object", "properties": { "type": { "type": "string" }, "pattern": { "type": "string" } }, "required": [ "pattern", "type" ] }, "owners": { "type": "array", "items": { "type": "object", "description": "Owner as it appears in the API response (after identifier->name rename).", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "name", "type" ] } } }, "required": [ "matcher", "owners" ] } } }, "required": [ "$version", "rules" ], "nullable": true }, "raw": { "type": "string" }, "fallthrough": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "autoAssignment": { "type": "string" }, "codeownersAutoSync": { "type": "boolean" } }, "required": [ "autoAssignment", "codeownersAutoSync", "dateCreated", "fallthrough", "isActive", "lastUpdated", "raw" ] }, "examples": { "UpdateOwnershipConfigurationForAProject": { "value": { "raw": "path:src/views/checkout jane.smith@org.com \nurl:https://example.com/checkout jane.smith@org.com\ntags.transaction:/checkout/:page jane.smith@org.com", "fallthrough": true, "dateCreated": "2023-10-03T20:25:18.539823Z", "lastUpdated": "2023-10-03T22:49:12.294741Z", "isActive": true, "autoAssignment": "Auto Assign to Issue Owner", "codeownersAutoSync": true, "schema": { "$version": 1, "rules": [ { "matcher": { "type": "path", "pattern": "src/views/checkout" }, "owners": [ { "type": "user", "id": "2621754", "name": "jane.smith@org.com" } ] }, { "matcher": { "type": "url", "pattern": "https://example.com/checkout" }, "owners": [ { "type": "user", "id": "2621754", "name": "jane.smith@org.com" } ] }, { "matcher": { "type": "tags.transaction", "pattern": "/checkout/:page" }, "owners": [ { "type": "user", "id": "2621754", "name": "jane.smith@org.com" } ] } ] } }, "summary": "Update ownership configuration for a project" } } } }, "description": "" }, "400": { "description": "Bad Request" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprod/size-analysis/status-check-rules/": { "get": { "operationId": "Retrieve Size Analysis status check rules for a project", "description": "Retrieve the current Size Analysis status check rules configured for a project.\n\nUse this endpoint after receiving a `size_analysis.completed` webhook when you\nwant external CI to evaluate the same Size Analysis status check thresholds that\nSentry uses. The endpoint returns the current project configuration, not a\nhistorical snapshot from when the webhook was emitted.\n\nThe response includes whether status check enforcement is enabled and the\nnormalized rule list Sentry uses when evaluating Size Analysis thresholds.\n\nThis endpoint requires a bearer token with `project:read` access. Project\ndistribution tokens are not supported.\n\nResponse notes:\n\n- `enabled: false` means status-check enforcement is disabled for the project.\n- `rules: []` means there are no configured thresholds to evaluate.\n- `value` is returned as a string. For `absolute` and `absolute_diff`\n measurements it is a byte value; for `relative_diff` it is a percentage.\n- `filterQuery` is the original configured filter string.\n- `filters` is the machine-readable version of `filterQuery`.\n- `filters: []` means the rule has no filters and applies to all builds.\n- `filters: null` means the saved filter query could not be parsed; Sentry's\n status check trigger treats that rule as non-matching.\n\nRule evaluation semantics:\n\n- Threshold comparisons are strict: a rule triggers only when the computed value\n is greater than the configured threshold, not greater than or equal to it.\n- `absolute_diff` and `relative_diff` require a matching base metric/build.\n- `relative_diff` does not trigger when the base size is zero.\n- `artifactType` identifies the artifact scope the rule evaluates.\n `main_artifact`, `watch_artifact`, `android_dynamic_feature_artifact`,\n and `app_clip_artifact` target their matching artifact metric.\n `all_artifacts` evaluates all available artifact metrics.\n- Rule filters support the keys `app_id`, `git_head_ref`,\n `build_configuration_name`, and `platform_name`.\n- Filter objects are combined with AND. Multiple `conditions` inside one\n filter object are combined with OR.\n- Each condition uses `values`; single-value operators still return a\n one-item array.\n- Values in `filters` are decoded literal values for exact/simple operators,\n not query syntax. For example, `app_id:\\*com` in `filterQuery` becomes\n `values: [\"*com\"]` with `operator: \"equals\"`.\n- The same key can appear in more than one filter object when positive and\n negative conditions both exist; those filter objects are still combined with\n AND.\n- Supported filter operators are `equals`, `notEquals`, `in`, `notIn`,\n `contains`, `notContains`, `startsWith`, `notStartsWith`, `endsWith`,\n `notEndsWith`, `matches`, and `notMatches`.\n- `matches` and `notMatches` values use Sentry wildcard pattern syntax, not\n regular expressions. `*` matches zero or more characters, escaped `\\*`\n matches a literal asterisk, and a pattern without `*` is an exact match.\n- `in` and `notIn` are evaluated as one condition against all values, matching\n Sentry's status check trigger behavior.\n- A rule applies only when the build metadata matches all filters. If a\n referenced metadata key is missing, the filter does not match, even for\n negated operators.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Mobile Builds" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "metric": { "enum": [ "install_size", "download_size" ], "type": "string" }, "measurement": { "enum": [ "absolute", "absolute_diff", "relative_diff" ], "type": "string" }, "value": { "type": "string" }, "filterQuery": { "type": "string" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "enum": [ "app_id", "build_configuration_name", "git_head_ref", "platform_name" ], "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "operator": { "enum": [ "contains", "endsWith", "equals", "in", "matches", "notContains", "notEndsWith", "notEquals", "notIn", "notMatches", "notStartsWith", "startsWith" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "values" ] } } }, "required": [ "conditions", "key" ] }, "nullable": true }, "artifactType": { "enum": [ "main_artifact", "watch_artifact", "android_dynamic_feature_artifact", "app_clip_artifact", "all_artifacts" ], "type": "string" } }, "required": [ "artifactType", "filterQuery", "filters", "id", "measurement", "metric", "value" ] } } }, "required": [ "enabled", "rules" ] }, "examples": { "ConfiguredSizeAnalysisStatusCheckRules": { "value": { "enabled": true, "rules": [ { "id": "rule-1", "metric": "install_size", "measurement": "absolute_diff", "value": "5000000", "filterQuery": "app_id:com.example.app platform_name:apple build_configuration_name:Release", "filters": [ { "key": "app_id", "conditions": [ { "operator": "equals", "values": [ "com.example.app" ] } ] }, { "key": "platform_name", "conditions": [ { "operator": "equals", "values": [ "apple" ] } ] }, { "key": "build_configuration_name", "conditions": [ { "operator": "equals", "values": [ "Release" ] } ] } ], "artifactType": "main_artifact" } ] }, "summary": "Configured Size Analysis Status Check Rules" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprodartifacts/build-distribution/latest/": { "get": { "operationId": "Get the latest installable build for a project", "description": "Get the latest installable build for a project.\n\nReturns the latest installable build matching filter criteria.\nWhen buildVersion is provided, also returns the current build and\nwhether an update is available.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "query", "name": "appId", "schema": { "type": "string" }, "description": "App identifier (exact match).", "required": true }, { "in": "query", "name": "platform", "schema": { "type": "string" }, "description": "Platform: \"apple\" or \"android\".", "required": true }, { "in": "query", "name": "buildVersion", "schema": { "type": "string" }, "description": "Current build version. When provided, enables check-for-updates mode." }, { "in": "query", "name": "buildNumber", "schema": { "type": "integer" }, "description": "Current build number. Either this or mainBinaryIdentifier must be provided when buildVersion is set." }, { "in": "query", "name": "mainBinaryIdentifier", "schema": { "type": "string" }, "description": "UUID of the main binary (e.g. Mach-O UUID for Apple builds). Either this or buildNumber must be provided when buildVersion is set." }, { "in": "query", "name": "buildConfiguration", "schema": { "type": "string" }, "description": "Filter by build configuration name (exact match)." }, { "in": "query", "name": "codesigningType", "schema": { "type": "string" }, "description": "Filter by code signing type." }, { "in": "query", "name": "installGroups", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Filter by install group name (repeatable for multiple groups)." } ], "tags": [ "Mobile Builds" ], "security": [ { "auth_token": [ "project:admin", "project:distribution", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "latestArtifact": { "type": "object", "properties": { "buildId": { "type": "string" }, "state": { "type": "string" }, "appInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ] }, "gitInfo": { "type": "object", "properties": { "headSha": { "type": "string", "nullable": true }, "baseSha": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "headRepoName": { "type": "string", "nullable": true }, "baseRepoName": { "type": "string", "nullable": true }, "headRef": { "type": "string", "nullable": true }, "baseRef": { "type": "string", "nullable": true }, "prNumber": { "type": "integer", "nullable": true } }, "required": [ "baseRef", "baseRepoName", "baseSha", "headRef", "headRepoName", "headSha", "prNumber", "provider" ], "nullable": true }, "platform": { "type": "string", "nullable": true }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "buildConfiguration": { "type": "string", "nullable": true }, "isInstallable": { "type": "boolean" }, "installUrl": { "type": "string", "nullable": true }, "installUrlExpiresAt": { "type": "string", "nullable": true }, "downloadCount": { "type": "integer" }, "releaseNotes": { "type": "string", "nullable": true }, "installGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isCodeSignatureValid": { "type": "boolean", "nullable": true }, "profileName": { "type": "string", "nullable": true }, "codesigningType": { "type": "string", "nullable": true } }, "required": [ "appInfo", "buildConfiguration", "buildId", "codesigningType", "downloadCount", "gitInfo", "installGroups", "installUrl", "installUrlExpiresAt", "isCodeSignatureValid", "isInstallable", "platform", "profileName", "projectId", "projectSlug", "releaseNotes", "state" ], "nullable": true }, "currentArtifact": { "type": "object", "properties": { "buildId": { "type": "string" }, "state": { "type": "string" }, "appInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ] }, "gitInfo": { "type": "object", "properties": { "headSha": { "type": "string", "nullable": true }, "baseSha": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "headRepoName": { "type": "string", "nullable": true }, "baseRepoName": { "type": "string", "nullable": true }, "headRef": { "type": "string", "nullable": true }, "baseRef": { "type": "string", "nullable": true }, "prNumber": { "type": "integer", "nullable": true } }, "required": [ "baseRef", "baseRepoName", "baseSha", "headRef", "headRepoName", "headSha", "prNumber", "provider" ], "nullable": true }, "platform": { "type": "string", "nullable": true }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "buildConfiguration": { "type": "string", "nullable": true }, "isInstallable": { "type": "boolean" }, "installUrl": { "type": "string", "nullable": true }, "installUrlExpiresAt": { "type": "string", "nullable": true }, "downloadCount": { "type": "integer" }, "releaseNotes": { "type": "string", "nullable": true }, "installGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isCodeSignatureValid": { "type": "boolean", "nullable": true }, "profileName": { "type": "string", "nullable": true }, "codesigningType": { "type": "string", "nullable": true } }, "required": [ "appInfo", "buildConfiguration", "buildId", "codesigningType", "downloadCount", "gitInfo", "installGroups", "installUrl", "installUrlExpiresAt", "isCodeSignatureValid", "isInstallable", "platform", "profileName", "projectId", "projectSlug", "releaseNotes", "state" ], "nullable": true } }, "required": [ "currentArtifact", "latestArtifact" ] }, "examples": { "LatestBuildOnly": { "value": { "latestArtifact": { "buildId": "12345", "state": "PROCESSED", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "platform": "ANDROID", "projectId": "1", "projectSlug": "my-project", "buildConfiguration": "release", "isInstallable": true, "installUrl": "https://sentry.io/api/0/projects/org/project/files/installablepreprodartifact/abc123/?response_format=apk", "installUrlExpiresAt": "2025-01-15T22:30:00+00:00", "downloadCount": 5, "releaseNotes": "Bug fixes and performance improvements.", "installGroups": [ "beta-testers" ], "isCodeSignatureValid": null, "profileName": null, "codesigningType": null }, "currentArtifact": null }, "summary": "Latest Build Only" }, "UpdateAvailable": { "value": { "latestArtifact": { "buildId": "12346", "state": "PROCESSED", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.3.0", "buildNumber": 50, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "platform": "ANDROID", "projectId": "1", "projectSlug": "my-project", "buildConfiguration": "release", "isInstallable": true, "installUrl": "https://sentry.io/api/0/projects/org/project/files/installablepreprodartifact/abc123/?response_format=apk", "installUrlExpiresAt": "2025-01-15T22:30:00+00:00", "downloadCount": 5, "releaseNotes": "Bug fixes and performance improvements.", "installGroups": [ "beta-testers" ], "isCodeSignatureValid": null, "profileName": null, "codesigningType": null }, "currentArtifact": { "buildId": "12345", "state": "PROCESSED", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "platform": "ANDROID", "projectId": "1", "projectSlug": "my-project", "buildConfiguration": "release", "isInstallable": true, "installUrl": "https://sentry.io/api/0/projects/org/project/files/installablepreprodartifact/abc123/?response_format=apk", "installUrlExpiresAt": "2025-01-15T22:30:00+00:00", "downloadCount": 5, "releaseNotes": "Bug fixes and performance improvements.", "installGroups": [ "beta-testers" ], "isCodeSignatureValid": null, "profileName": null, "codesigningType": null } }, "summary": "Update Available" }, "NoUpdateAvailable": { "value": { "latestArtifact": { "buildId": "12345", "state": "PROCESSED", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "platform": "ANDROID", "projectId": "1", "projectSlug": "my-project", "buildConfiguration": "release", "isInstallable": true, "installUrl": "https://sentry.io/api/0/projects/org/project/files/installablepreprodartifact/abc123/?response_format=apk", "installUrlExpiresAt": "2025-01-15T22:30:00+00:00", "downloadCount": 5, "releaseNotes": "Bug fixes and performance improvements.", "installGroups": [ "beta-testers" ], "isCodeSignatureValid": null, "profileName": null, "codesigningType": null }, "currentArtifact": { "buildId": "12345", "state": "PROCESSED", "appInfo": { "appId": "com.example.app", "name": "Example App", "version": "1.2.0", "buildNumber": 42, "artifactType": "AAB", "dateAdded": "2025-01-15T10:30:00+00:00", "dateBuilt": "2025-01-15T10:00:00+00:00" }, "gitInfo": { "headSha": "abc123def456", "baseSha": "789xyz000111", "provider": "github", "headRepoName": "org/repo", "baseRepoName": "org/repo", "headRef": "feature-branch", "baseRef": "main", "prNumber": 42 }, "platform": "ANDROID", "projectId": "1", "projectSlug": "my-project", "buildConfiguration": "release", "isInstallable": true, "installUrl": "https://sentry.io/api/0/projects/org/project/files/installablepreprodartifact/abc123/?response_format=apk", "installUrlExpiresAt": "2025-01-15T22:30:00+00:00", "downloadCount": 5, "releaseNotes": "Bug fixes and performance improvements.", "installGroups": [ "beta-testers" ], "isCodeSignatureValid": null, "profileName": null, "codesigningType": null } }, "summary": "No Update Available" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/": { "delete": { "operationId": "Delete a Replay Instance", "description": "Delete a replay.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "replay_id", "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the replay you'd like to retrieve.", "required": true } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/clicks/": { "get": { "operationId": "List Clicked Nodes", "description": "Retrieve a collection of RRWeb DOM node-ids and the timestamp they were clicked.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "replay_id", "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the replay you'd like to retrieve.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "Filters results by using [query syntax](/product/sentry-basics/search/).\n\nExample: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`\n" } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "integer" }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "node_id", "timestamp" ] } } }, "required": [ "data" ] }, "examples": { "RetrieveACollectionOfRRWebDOMNode-idsAndTheTimestampTheyWereClicked.": { "value": { "data": [ { "node_id": 1, "timestamp": "2024-02-08T15:52:25+00:00" } ] }, "summary": "Retrieve a collection of RRWeb DOM node-ids and the timestamp they were clicked." } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/recording-segments/": { "get": { "operationId": "List Recording Segments", "description": "Return a collection of replay recording segments.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "replay_id", "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the replay you'd like to retrieve.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, { "in": "query", "name": "per_page", "schema": { "type": "integer" }, "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "examples": { "RetrieveACollectionOfReplaySegments": { "value": [ [ { "type": 5, "timestamp": 1658770772.902, "data": { "tag": "performanceSpan", "payload": { "op": "memory", "description": "", "startTimestamp": 1658770772.902, "endTimestamp": 1658770772.902, "data": { "memory": { "jsHeapSizeLimit": 4294705152, "totalJSHeapSize": 10204109, "usedJSHeapSize": 9131621 } } } } } ], [ { "type": 5, "timestamp": 1665063926.125, "data": { "tag": "performanceSpan", "payload": { "op": "navigation.navigate", "description": "https://sentry.io", "startTimestamp": 1665063926.125, "endTimestamp": 1665063926.833, "data": { "size": 9538, "duration": 710 } } } } ] ], "summary": "Retrieve a collection of replay segments" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/recording-segments/{segment_id}/": { "get": { "operationId": "Retrieve a Recording Segment", "description": "Return a replay recording segment.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "replay_id", "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the replay you'd like to retrieve.", "required": true }, { "in": "path", "name": "segment_id", "schema": { "type": "integer" }, "description": "The ID of the segment you'd like to retrieve.", "required": true } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "examples": { "RetrieveAReplaySegment": { "value": [ { "type": 5, "timestamp": 1658770772.902, "data": { "tag": "performanceSpan", "payload": { "op": "memory", "description": "", "startTimestamp": 1658770772.902, "endTimestamp": 1658770772.902, "data": { "memory": { "jsHeapSizeLimit": 4294705152, "totalJSHeapSize": 10204109, "usedJSHeapSize": 9131621 } } } } } ], "summary": "Retrieve a replay segment" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/viewed-by/": { "get": { "operationId": "List Users Who Have Viewed a Replay", "description": "Return a list of users who have viewed a replay.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "replay_id", "schema": { "type": "string", "format": "uuid" }, "description": "The ID of the replay you'd like to retrieve.", "required": true } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "viewed_by": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "viewed_by" ] } }, "required": [ "data" ] }, "examples": { "GetListOfUsersWhoHaveViewedAReplay": { "value": { "data": { "viewed_by": [ { "id": "884411", "name": "some.body@sentry.io", "username": "d93522a35cb64c13991104bd73d44519", "email": "some.body@sentry.io", "avatarUrl": "https://gravatar.com/avatar/d93522a35cb64c13991104bd73d44519d93522a35cb64c13991104bd73d44519?s=32&d=mm", "isActive": true, "hasPasswordAuth": false, "isManaged": false, "dateJoined": "2022-07-25T23:36:29.593212Z", "lastLogin": "2024-03-14T18:11:28.740309Z", "has2fa": true, "lastActive": "2024-03-15T22:22:06.925934Z", "isSuperuser": true, "isStaff": false, "experiments": {}, "emails": [ { "id": "2231333", "email": "some.body@sentry.io", "is_verified": true } ], "avatar": { "avatarType": "upload", "avatarUuid": "499dcd0764da42a589654a2224086e67", "avatarUrl": "https://sentry.io/avatar/499dcd0764da42a589654a2224086e67/" }, "type": "user" } ] } }, "summary": "Get list of users who have viewed a replay" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/jobs/delete/": { "get": { "operationId": "List Replay Batch-Deletion Jobs", "description": "Retrieve a collection of replay delete jobs.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "rangeStart": { "type": "string" }, "rangeEnd": { "type": "string" }, "environments": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "query": { "type": "string" }, "countDeleted": { "type": "integer" } }, "required": [ "countDeleted", "dateCreated", "dateUpdated", "environments", "id", "query", "rangeEnd", "rangeStart", "status" ] } } }, "required": [ "data" ] }, "examples": { "ListReplayBatchDeletionJobs": { "value": { "data": [ { "id": 1, "dateCreated": "2024-01-01T00:00:00Z", "dateUpdated": "2024-01-01T00:05:00Z", "rangeStart": "2023-12-01T00:00:00Z", "rangeEnd": "2024-01-01T00:00:00Z", "environments": [ "production" ], "status": "pending", "query": "user.email:test@example.com", "countDeleted": 0 } ] }, "summary": "List replay batch deletion jobs" } } } }, "description": "" }, "403": { "description": "Forbidden" } } }, "post": { "operationId": "Create Replay Batch Deletion Job", "description": "Create a new replay deletion job.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Replays" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "rangeStart": { "type": "string", "format": "date-time" }, "rangeEnd": { "type": "string", "format": "date-time" }, "environments": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string", "nullable": true } }, "required": [ "environments", "query", "rangeEnd", "rangeStart" ] } }, "required": [ "data" ] } } }, "required": true }, "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "rangeStart": { "type": "string" }, "rangeEnd": { "type": "string" }, "environments": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "query": { "type": "string" }, "countDeleted": { "type": "integer" } }, "required": [ "countDeleted", "dateCreated", "dateUpdated", "environments", "id", "query", "rangeEnd", "rangeStart", "status" ] } }, "required": [ "data" ] }, "examples": { "CreateAnAsyncJobToBatchDeleteReplayInstances": { "value": { "data": { "id": 1, "dateCreated": "2024-01-01T00:00:00Z", "dateUpdated": "2024-01-01T00:05:00Z", "rangeStart": "2023-12-01T00:00:00Z", "rangeEnd": "2024-01-01T00:00:00Z", "environments": [ "production" ], "status": "pending", "query": "user.email:test@example.com", "countDeleted": 0 } }, "summary": "Create an async job to batch delete replay instances" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/jobs/delete/{job_id}/": { "get": { "operationId": "Retrieve a Replay Batch-Deletion Job", "description": "Fetch a replay delete job instance.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "job_id", "schema": { "type": "integer" }, "description": "The ID of the replay deletion job you'd like to retrieve.", "required": true } ], "tags": [ "Replays" ], "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "rangeStart": { "type": "string" }, "rangeEnd": { "type": "string" }, "environments": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "query": { "type": "string" }, "countDeleted": { "type": "integer" } }, "required": [ "countDeleted", "dateCreated", "dateUpdated", "environments", "id", "query", "rangeEnd", "rangeStart", "status" ] } }, "required": [ "data" ] }, "examples": { "GetAReplayBatchDeletionJob": { "value": { "data": { "id": 1, "dateCreated": "2024-01-01T00:00:00Z", "dateUpdated": "2024-01-01T00:05:00Z", "rangeStart": "2023-12-01T00:00:00Z", "rangeEnd": "2024-01-01T00:00:00Z", "environments": [ "production" ], "status": "pending", "query": "user.email:test@example.com", "countDeleted": 0 } }, "summary": "Get a replay batch deletion job" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/symbol-sources/": { "get": { "operationId": "Retrieve a Project's Symbol Sources", "description": "List custom symbol sources configured for a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "The ID of the source to look up. If this is not provided, all sources are returned." } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http" ] }, "url": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "url", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "s3" ] }, "bucket": { "type": "string" }, "region": { "type": "string" }, "access_key": { "type": "string" }, "secret_key": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "prefix": { "type": "string" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "bucket", "region", "access_key", "secret_key", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "gcs" ] }, "bucket": { "type": "string" }, "client_email": { "type": "string" }, "private_key": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "prefix": { "type": "string" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "bucket", "client_email", "private_key", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "appStoreConnect" ] }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "appconnectIssuer": { "type": "string", "minLength": 36, "maxLength": 36 }, "appconnectKey": { "type": "string", "minLength": 2, "maxLength": 20 }, "appconnectPrivateKey": { "type": "string" }, "appName": { "type": "string", "minLength": 1, "maxLength": 512 }, "appId": { "type": "string", "minLength": 1 }, "bundleId": { "type": "string", "minLength": 1 } }, "required": [ "type", "id", "name", "appconnectIssuer", "appconnectKey", "appconnectPrivateKey", "appName", "appId", "bundleId" ], "additionalProperties": false } ] } }, "examples": { "ListCustomSymbolSourcesConfiguredForAProject.": { "value": [ { "id": "honk", "name": "honk source", "layout": { "type": "native" }, "type": "http", "url": "http://honk.beep", "username": "honkhonk", "password": { "hidden-secret": true } }, { "id": "beep", "name": "beep source", "layout": { "type": "native" }, "type": "gcs", "bucket": "mybucket", "client_email": "honk@beep.com", "private_key": { "hidden-secret": true } } ], "summary": "List custom symbol sources configured for a project." } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Add a Symbol Source to a Project", "description": "Add a custom symbol source to a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "http", "gcs", "s3" ], "type": "string", "description": "The type of the source.\n\n* `http` - SymbolServer (HTTP)\n* `gcs` - Google Cloud Storage\n* `s3` - Amazon S3" }, "name": { "type": "string", "description": "The human-readable name of the source." }, "id": { "type": "string", "description": "The internal ID of the source. Must be distinct from all other source IDs and cannot start with '`sentry:`'. If this is not provided, a new UUID will be generated." }, "layout": { "type": "object", "description": "Layout settings for the source. This is required for HTTP, GCS, and S3 sources.\n\n**`type`** ***(string)*** - The layout of the folder structure. The options are:\n- `native` - Platform-Specific (SymStore / GDB / LLVM)\n- `symstore` - Microsoft SymStore\n- `symstore_index2` - Microsoft SymStore (with index2.txt)\n- `ssqp` - Microsoft SSQP\n- `unified` - Unified Symbol Server Layout\n- `debuginfod` - debuginfod\n\n**`casing`** ***(string)*** - The layout of the folder structure. The options are:\n- `default` - Default (mixed case)\n- `uppercase` - Uppercase\n- `lowercase` - Lowercase\n\n```json\n{\n \"layout\": {\n \"type\": \"native\"\n \"casing\": \"default\"\n }\n}\n```", "properties": { "type": { "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ], "type": "string", "description": "The source's layout type.\n\n* `native`\n* `symstore`\n* `symstore_index2`\n* `ssqp`\n* `unified`\n* `debuginfod`\n* `slashsymbols`" }, "casing": { "enum": [ "lowercase", "uppercase", "default" ], "type": "string", "description": "The source's casing rules.\n\n* `lowercase`\n* `uppercase`\n* `default`" } }, "required": [ "casing", "type" ] }, "filters": { "type": "object", "description": "Filter settings for the source. This is optional for all sources.\n\n**`filetypes`** ***(list)*** - A list of file types that can be found on this source. If this is left empty, all file types will be enabled. The options are:\n- `pe` - Windows executable files\n- `pdb` - Windows debug files\n- `portablepdb` - .NET portable debug files\n- `mach_code` - MacOS executable files\n- `mach_debug` - MacOS debug files\n- `elf_code` - ELF executable files\n- `elf_debug` - ELF debug files\n- `wasm_code` - WASM executable files\n- `wasm_debug` - WASM debug files\n- `breakpad` - Breakpad symbol files\n- `sourcebundle` - Source code bundles\n- `uuidmap` - Apple UUID mapping files\n- `bcsymbolmap` - Apple bitcode symbol maps\n- `il2cpp` - Unity IL2CPP mapping files\n- `proguard` - ProGuard mapping files\n\n**`path_patterns`** ***(list)*** - A list of glob patterns to check against the debug and code file paths of debug files. Only files that match one of these patterns will be requested from the source. If this is left empty, no path-based filtering takes place.\n\n**`requires_checksum`** ***(boolean)*** - Whether this source requires a debug checksum to be sent with each request. Defaults to `false`.\n\n```json\n{\n \"filters\": {\n \"filetypes\": [\"pe\", \"pdb\", \"portablepdb\"],\n \"path_patterns\": [\"*ffmpeg*\"]\n }\n}\n```", "properties": { "filetypes": { "type": "array", "items": { "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ], "type": "string", "description": "* `pe`\n* `pdb`\n* `portablepdb`\n* `mach_debug`\n* `mach_code`\n* `elf_debug`\n* `elf_code`\n* `wasm_debug`\n* `wasm_code`\n* `breakpad`\n* `sourcebundle`\n* `uuidmap`\n* `bcsymbolmap`\n* `il2cpp`\n* `proguard`\n* `dartsymbolmap`" }, "description": "The file types enabled for the source." }, "path_patterns": { "type": "array", "items": { "type": "string" }, "description": "The debug and code file paths enabled for the source." }, "requires_checksum": { "type": "boolean", "description": "Whether the source requires debug checksums." } } }, "url": { "type": "string", "description": "The source's URL. Optional for HTTP sources, invalid for all others." }, "username": { "type": "string", "description": "The user name for accessing the source. Optional for HTTP sources, invalid for all others." }, "password": { "type": "string", "description": "The password for accessing the source. Optional for HTTP sources, invalid for all others." }, "bucket": { "type": "string", "description": "The GCS or S3 bucket where the source resides. Required for GCS and S3 source, invalid for HTTP sources." }, "region": { "enum": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-east-1", "ap-south-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-north-1", "sa-east-1", "us-gov-east-1", "us-gov-west-1" ], "type": "string", "description": "The source's [S3 region](https://docs.aws.amazon.com/general/latest/gr/s3.html). Required for S3 sources, invalid for all others.\n\n* `us-east-2` - US East (Ohio)\n* `us-east-1` - US East (N. Virginia)\n* `us-west-1` - US West (N. California)\n* `us-west-2` - US West (Oregon)\n* `ap-east-1` - Asia Pacific (Hong Kong)\n* `ap-south-1` - Asia Pacific (Mumbai)\n* `ap-northeast-2` - Asia Pacific (Seoul)\n* `ap-southeast-1` - Asia Pacific (Singapore)\n* `ap-southeast-2` - Asia Pacific (Sydney)\n* `ap-northeast-1` - Asia Pacific (Tokyo)\n* `ca-central-1` - Canada (Central)\n* `cn-north-1` - China (Beijing)\n* `cn-northwest-1` - China (Ningxia)\n* `eu-central-1` - EU (Frankfurt)\n* `eu-west-1` - EU (Ireland)\n* `eu-west-2` - EU (London)\n* `eu-west-3` - EU (Paris)\n* `eu-north-1` - EU (Stockholm)\n* `sa-east-1` - South America (São Paulo)\n* `us-gov-east-1` - AWS GovCloud (US-East)\n* `us-gov-west-1` - AWS GovCloud (US)" }, "access_key": { "type": "string", "description": "The [AWS Access Key](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html#access-keys-and-secret-access-keys).Required for S3 sources, invalid for all others." }, "secret_key": { "type": "string", "description": "The [AWS Secret Access Key](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html#access-keys-and-secret-access-keys).Required for S3 sources, invalid for all others." }, "prefix": { "type": "string", "description": "The GCS or [S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) prefix. Optional for GCS and S3 sourcse, invalid for HTTP." }, "client_email": { "type": "string", "description": "The GCS email address for authentication. Required for GCS sources, invalid for all others." }, "private_key": { "type": "string", "description": "The GCS private key. Required for GCS sources if not using impersonated tokens. Invalid for all others." } }, "required": [ "name", "type" ] } } }, "required": true }, "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http" ] }, "url": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "url", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "s3" ] }, "bucket": { "type": "string" }, "region": { "type": "string" }, "access_key": { "type": "string" }, "secret_key": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "prefix": { "type": "string" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "bucket", "region", "access_key", "secret_key", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "gcs" ] }, "bucket": { "type": "string" }, "client_email": { "type": "string" }, "private_key": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "prefix": { "type": "string" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "bucket", "client_email", "private_key", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "appStoreConnect" ] }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "appconnectIssuer": { "type": "string", "minLength": 36, "maxLength": 36 }, "appconnectKey": { "type": "string", "minLength": 2, "maxLength": 20 }, "appconnectPrivateKey": { "type": "string" }, "appName": { "type": "string", "minLength": 1, "maxLength": 512 }, "appId": { "type": "string", "minLength": 1 }, "bundleId": { "type": "string", "minLength": 1 } }, "required": [ "type", "id", "name", "appconnectIssuer", "appconnectKey", "appconnectPrivateKey", "appName", "appId", "bundleId" ], "additionalProperties": false } ] }, "examples": { "AddACustomSymbolSourceToAProject.": { "value": { "id": "honk", "name": "honk source", "layout": { "type": "native" }, "type": "http", "url": "http://honk.beep", "username": "honkhonk", "password": { "hidden-secret": true } }, "summary": "Add a custom symbol source to a project." } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } }, "put": { "operationId": "Update a Project's Symbol Source", "description": "Update a custom symbol source in a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "The ID of the source to update.", "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "http", "gcs", "s3" ], "type": "string", "description": "The type of the source.\n\n* `http` - SymbolServer (HTTP)\n* `gcs` - Google Cloud Storage\n* `s3` - Amazon S3" }, "name": { "type": "string", "description": "The human-readable name of the source." }, "id": { "type": "string", "description": "The internal ID of the source. Must be distinct from all other source IDs and cannot start with '`sentry:`'. If this is not provided, a new UUID will be generated." }, "layout": { "type": "object", "description": "Layout settings for the source. This is required for HTTP, GCS, and S3 sources.\n\n**`type`** ***(string)*** - The layout of the folder structure. The options are:\n- `native` - Platform-Specific (SymStore / GDB / LLVM)\n- `symstore` - Microsoft SymStore\n- `symstore_index2` - Microsoft SymStore (with index2.txt)\n- `ssqp` - Microsoft SSQP\n- `unified` - Unified Symbol Server Layout\n- `debuginfod` - debuginfod\n\n**`casing`** ***(string)*** - The layout of the folder structure. The options are:\n- `default` - Default (mixed case)\n- `uppercase` - Uppercase\n- `lowercase` - Lowercase\n\n```json\n{\n \"layout\": {\n \"type\": \"native\"\n \"casing\": \"default\"\n }\n}\n```", "properties": { "type": { "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ], "type": "string", "description": "The source's layout type.\n\n* `native`\n* `symstore`\n* `symstore_index2`\n* `ssqp`\n* `unified`\n* `debuginfod`\n* `slashsymbols`" }, "casing": { "enum": [ "lowercase", "uppercase", "default" ], "type": "string", "description": "The source's casing rules.\n\n* `lowercase`\n* `uppercase`\n* `default`" } }, "required": [ "casing", "type" ] }, "filters": { "type": "object", "description": "Filter settings for the source. This is optional for all sources.\n\n**`filetypes`** ***(list)*** - A list of file types that can be found on this source. If this is left empty, all file types will be enabled. The options are:\n- `pe` - Windows executable files\n- `pdb` - Windows debug files\n- `portablepdb` - .NET portable debug files\n- `mach_code` - MacOS executable files\n- `mach_debug` - MacOS debug files\n- `elf_code` - ELF executable files\n- `elf_debug` - ELF debug files\n- `wasm_code` - WASM executable files\n- `wasm_debug` - WASM debug files\n- `breakpad` - Breakpad symbol files\n- `sourcebundle` - Source code bundles\n- `uuidmap` - Apple UUID mapping files\n- `bcsymbolmap` - Apple bitcode symbol maps\n- `il2cpp` - Unity IL2CPP mapping files\n- `proguard` - ProGuard mapping files\n\n**`path_patterns`** ***(list)*** - A list of glob patterns to check against the debug and code file paths of debug files. Only files that match one of these patterns will be requested from the source. If this is left empty, no path-based filtering takes place.\n\n**`requires_checksum`** ***(boolean)*** - Whether this source requires a debug checksum to be sent with each request. Defaults to `false`.\n\n```json\n{\n \"filters\": {\n \"filetypes\": [\"pe\", \"pdb\", \"portablepdb\"],\n \"path_patterns\": [\"*ffmpeg*\"]\n }\n}\n```", "properties": { "filetypes": { "type": "array", "items": { "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ], "type": "string", "description": "* `pe`\n* `pdb`\n* `portablepdb`\n* `mach_debug`\n* `mach_code`\n* `elf_debug`\n* `elf_code`\n* `wasm_debug`\n* `wasm_code`\n* `breakpad`\n* `sourcebundle`\n* `uuidmap`\n* `bcsymbolmap`\n* `il2cpp`\n* `proguard`\n* `dartsymbolmap`" }, "description": "The file types enabled for the source." }, "path_patterns": { "type": "array", "items": { "type": "string" }, "description": "The debug and code file paths enabled for the source." }, "requires_checksum": { "type": "boolean", "description": "Whether the source requires debug checksums." } } }, "url": { "type": "string", "description": "The source's URL. Optional for HTTP sources, invalid for all others." }, "username": { "type": "string", "description": "The user name for accessing the source. Optional for HTTP sources, invalid for all others." }, "password": { "type": "string", "description": "The password for accessing the source. Optional for HTTP sources, invalid for all others." }, "bucket": { "type": "string", "description": "The GCS or S3 bucket where the source resides. Required for GCS and S3 source, invalid for HTTP sources." }, "region": { "enum": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-east-1", "ap-south-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-north-1", "sa-east-1", "us-gov-east-1", "us-gov-west-1" ], "type": "string", "description": "The source's [S3 region](https://docs.aws.amazon.com/general/latest/gr/s3.html). Required for S3 sources, invalid for all others.\n\n* `us-east-2` - US East (Ohio)\n* `us-east-1` - US East (N. Virginia)\n* `us-west-1` - US West (N. California)\n* `us-west-2` - US West (Oregon)\n* `ap-east-1` - Asia Pacific (Hong Kong)\n* `ap-south-1` - Asia Pacific (Mumbai)\n* `ap-northeast-2` - Asia Pacific (Seoul)\n* `ap-southeast-1` - Asia Pacific (Singapore)\n* `ap-southeast-2` - Asia Pacific (Sydney)\n* `ap-northeast-1` - Asia Pacific (Tokyo)\n* `ca-central-1` - Canada (Central)\n* `cn-north-1` - China (Beijing)\n* `cn-northwest-1` - China (Ningxia)\n* `eu-central-1` - EU (Frankfurt)\n* `eu-west-1` - EU (Ireland)\n* `eu-west-2` - EU (London)\n* `eu-west-3` - EU (Paris)\n* `eu-north-1` - EU (Stockholm)\n* `sa-east-1` - South America (São Paulo)\n* `us-gov-east-1` - AWS GovCloud (US-East)\n* `us-gov-west-1` - AWS GovCloud (US)" }, "access_key": { "type": "string", "description": "The [AWS Access Key](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html#access-keys-and-secret-access-keys).Required for S3 sources, invalid for all others." }, "secret_key": { "type": "string", "description": "The [AWS Secret Access Key](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html#access-keys-and-secret-access-keys).Required for S3 sources, invalid for all others." }, "prefix": { "type": "string", "description": "The GCS or [S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) prefix. Optional for GCS and S3 sourcse, invalid for HTTP." }, "client_email": { "type": "string", "description": "The GCS email address for authentication. Required for GCS sources, invalid for all others." }, "private_key": { "type": "string", "description": "The GCS private key. Required for GCS sources if not using impersonated tokens. Invalid for all others." } }, "required": [ "name", "type" ] } } }, "required": true }, "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http" ] }, "url": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "url", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "s3" ] }, "bucket": { "type": "string" }, "region": { "type": "string" }, "access_key": { "type": "string" }, "secret_key": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "prefix": { "type": "string" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "bucket", "region", "access_key", "secret_key", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "gcs" ] }, "bucket": { "type": "string" }, "client_email": { "type": "string" }, "private_key": { "type": "object", "properties": { "hidden-secret": { "type": "boolean", "enum": [ true ] } } }, "prefix": { "type": "string" }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ] }, "casing": { "type": "string", "enum": [ "lowercase", "uppercase", "default" ] } }, "required": [ "type" ], "additionalProperties": false }, "filters": { "type": "object", "properties": { "filetypes": { "type": "array", "items": { "type": "string", "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ] } }, "path_patterns": { "type": "array", "items": { "type": "string" } }, "requires_checksum": { "type": "boolean" } }, "additionalProperties": false }, "is_public": { "type": "boolean" }, "has_index": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "id", "bucket", "client_email", "private_key", "layout" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "appStoreConnect" ] }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "appconnectIssuer": { "type": "string", "minLength": 36, "maxLength": 36 }, "appconnectKey": { "type": "string", "minLength": 2, "maxLength": 20 }, "appconnectPrivateKey": { "type": "string" }, "appName": { "type": "string", "minLength": 1, "maxLength": 512 }, "appId": { "type": "string", "minLength": 1 }, "bundleId": { "type": "string", "minLength": 1 } }, "required": [ "type", "id", "name", "appconnectIssuer", "appconnectKey", "appconnectPrivateKey", "appName", "appId", "bundleId" ], "additionalProperties": false } ] }, "examples": { "UpdateACustomSymbolSourceInAProject.": { "value": { "id": "honk", "name": "honk source", "layout": { "type": "native" }, "type": "http", "url": "http://honk.beep", "username": "honkhonk", "password": { "hidden-secret": true } }, "summary": "Update a custom symbol source in a project." } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete a Symbol Source from a Project", "description": "Delete a custom symbol source from a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "The ID of the source to delete.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/teams/": { "get": { "operationId": "List a Project's Teams", "description": "Return a list of teams that have access to this project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] } }, "examples": { "ListAProject'sTeams": { "value": [ { "id": "4502349234123", "slug": "ancient-gabelers", "name": "Ancient Gabelers", "dateCreated": "2023-05-31T19:47:53.621181Z", "isMember": true, "teamRole": "contributor", "flags": { "idp:provisioned": false }, "access": [ "alerts:read", "event:write", "project:read", "team:read", "member:read", "project:releases", "event:read", "org:read" ], "hasAccess": true, "isPending": false, "memberCount": 3, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null } }, { "id": "4502349234125", "slug": "squeaky-minnows", "name": "Squeaky Minnows", "dateCreated": "2023-07-27T11:23:34.621181Z", "isMember": true, "teamRole": "contributor", "flags": { "idp:provisioned": false }, "access": [ "alerts:read", "event:write", "project:read", "team:read", "member:read", "project:releases", "event:read", "org:read" ], "hasAccess": true, "isPending": false, "memberCount": 5, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null } } ], "summary": "List a project's teams" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/teams/{team_id_or_slug}/": { "post": { "operationId": "Add a Team to a Project", "description": "Give a team access to a project.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status", "teams" ] }, "examples": { "GiveATeamAccessToAProject": { "value": { "id": "6758470122493650", "slug": "the-spoiled-yoghurt", "name": "The Spoiled Yoghurt", "platform": "javascript", "dateCreated": "2023-03-29T15:25:21.344565Z", "isBookmarked": false, "isMember": true, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": null, "firstTransactionEvent": false, "access": [ "member:read", "event:read", "project:admin", "team:write", "project:write", "team:admin", "project:read", "org:integrations", "org:read", "project:releases", "team:read", "alerts:write", "event:admin", "event:write", "alerts:read" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasFeedbacks": false, "hasMonitors": false, "hasNewFeedbacks": false, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasSessions": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#5cbf3f", "status": "active", "team": { "id": "2349234102", "name": "Prime Mover", "slug": "prime-mover" }, "teams": [ { "id": "2349234102", "name": "Prime Mover", "slug": "prime-mover" }, { "id": "47584447", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" } ] }, "summary": "Give a Team Access to a Project" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete a Team from a Project", "description": "Revoke a team's access to a project.\n\nNote that Team Admins can only revoke access to teams they are admins of.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "project_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the project the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status", "teams" ] }, "examples": { "RevokeATeam'sAccessToAProject": { "value": { "id": "6758470122493650", "slug": "the-spoiled-yoghurt", "name": "The Spoiled Yoghurt", "platform": "javascript", "dateCreated": "2023-03-29T15:25:21.344565Z", "isBookmarked": false, "isMember": true, "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": null, "firstTransactionEvent": false, "access": [ "member:read", "event:read", "project:admin", "team:write", "project:write", "team:admin", "project:read", "org:integrations", "org:read", "project:releases", "team:read", "alerts:write", "event:admin", "event:write", "alerts:read" ], "hasAccess": true, "hasMinifiedStackTrace": false, "hasFeedbacks": false, "hasMonitors": false, "hasNewFeedbacks": false, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasSessions": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": true, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": false, "hasInsightsQueues": false, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "isInternal": false, "isPublic": false, "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "color": "#5cbf3f", "status": "active", "team": { "id": "2349234102", "name": "Prime Mover", "slug": "prime-mover" }, "teams": [ { "id": "2349234102", "name": "Prime Mover", "slug": "prime-mover" } ] }, "summary": "Revoke a Team's Access to a Project" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/seer/models/": { "get": { "operationId": "List Seer AI Models", "description": "Get list of actively used LLM model names from Seer.\n\nReturns the list of AI models that are currently used in production in Seer.\nThis endpoint does not require authentication and can be used to discover which models Seer uses.\n\nRequests to this endpoint should use the region-specific domain\neg. `us.sentry.io` or `de.sentry.io`", "tags": [ "Seer" ], "security": [ { "auth_token": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Response containing list of actively used LLM model names from Seer.", "properties": { "models": { "type": "array", "items": { "type": "string" } } }, "required": [ "models" ] } } }, "description": "" } }, "servers": [ { "url": "https://{region}.sentry.io" } ] } }, "/api/0/sentry-apps/{sentry_app_id_or_slug}/": { "get": { "operationId": "Retrieve a custom integration by ID or slug.", "description": "Retrieve a custom integration.", "parameters": [ { "in": "path", "name": "sentry_app_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the custom integration.", "required": true } ], "tags": [ "Integration" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write", "member:read", "org:read", "project:read", "project:releases", "team:read" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "avatars": { "type": "array", "items": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string" }, "avatarUrl": { "type": "string" }, "color": { "type": "boolean" }, "photoType": { "type": "string" } }, "required": [ "avatarType", "avatarUrl", "avatarUuid", "color", "photoType" ] } }, "events": { "type": "array", "items": { "type": "string" } }, "featureData": { "type": "array", "items": { "type": "string" } }, "isAlertable": { "type": "boolean" }, "metadata": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string" }, "status": { "type": "string" }, "uuid": { "type": "string" }, "verifyInstall": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "author": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "popularity": { "type": "integer", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true }, "webhookUrl": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "datePublished": { "type": "string", "format": "date-time" }, "clientId": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ] } }, "required": [ "allowedOrigins", "avatars", "events", "featureData", "isAlertable", "metadata", "name", "schema", "scopes", "slug", "status", "uuid", "verifyInstall" ] }, "examples": { "RetrieveACustomIntegration": { "value": { "allowedOrigins": [], "author": "ACME Corp", "avatars": [ { "avatarType": "avatar", "avatarUuid": "6c25b771-a576-4c18-a1c3-ab059c1d42ba", "avatarUrl": "https://example.com/avatar.png", "color": false, "photoType": "icon" } ], "events": [ "issue" ], "isAlertable": false, "isDisabled": false, "metadata": "", "name": "ACME Corp Integration", "overview": null, "popularity": 27, "redirectUrl": null, "featureData": [], "schema": "", "scopes": [ "event:read", "org:read" ], "slug": "acme-corp-integration", "status": "unpublished", "uuid": "77cebea3-019e-484d-8673-6c3969698827", "verifyInstall": true, "webhookUrl": "https://example.com/webhook", "clientId": "ed06141686bb60102d878c607eff449fa9907fa7a8cb70f0d337a8fb0b6566c3", "clientSecret": "**********", "owner": { "id": 42, "slug": "acme-corp" } }, "summary": "Retrieve a custom integration" } } } }, "description": "" } } }, "put": { "operationId": "Update an existing custom integration.", "description": "Update an existing custom integration.", "parameters": [ { "in": "path", "name": "sentry_app_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the custom integration.", "required": true } ], "tags": [ "Integration" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom integration." }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The custom integration's permission scopes for API access." }, "author": { "type": "string", "nullable": true, "description": "The custom integration's author." }, "events": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Webhook events the custom integration is subscribed to." }, "schema": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "The UI components schema, used to render the custom integration's configuration UI elements. See our [schema docs](https://docs.sentry.io/organization/integrations/integration-platform/ui-components/) for more information." }, "webhookUrl": { "type": "string", "format": "uri", "nullable": true, "description": "The webhook destination URL." }, "redirectUrl": { "type": "string", "format": "uri", "nullable": true, "description": "The post-installation redirect URL." }, "isInternal": { "type": "boolean", "default": false, "description": "Whether or not the integration is internal only. False means the integration is public." }, "isAlertable": { "type": "boolean", "default": false, "description": "Marks whether or not the custom integration can be used in an alert rule." }, "overview": { "type": "string", "nullable": true, "description": "The custom integration's description." }, "verifyInstall": { "type": "boolean", "default": true, "description": "Whether or not an installation of the custom integration should be verified." }, "allowedOrigins": { "type": "array", "items": { "type": "string", "maxLength": 255 }, "description": "The list of allowed origins for CORS." } }, "required": [ "name", "scopes" ] } } }, "required": true }, "security": [ { "auth_token": [ "org:admin", "org:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "avatars": { "type": "array", "items": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string" }, "avatarUrl": { "type": "string" }, "color": { "type": "boolean" }, "photoType": { "type": "string" } }, "required": [ "avatarType", "avatarUrl", "avatarUuid", "color", "photoType" ] } }, "events": { "type": "array", "items": { "type": "string" } }, "featureData": { "type": "array", "items": { "type": "string" } }, "isAlertable": { "type": "boolean" }, "metadata": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string" }, "status": { "type": "string" }, "uuid": { "type": "string" }, "verifyInstall": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "author": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "popularity": { "type": "integer", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true }, "webhookUrl": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "datePublished": { "type": "string", "format": "date-time" }, "clientId": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ] } }, "required": [ "allowedOrigins", "avatars", "events", "featureData", "isAlertable", "metadata", "name", "schema", "scopes", "slug", "status", "uuid", "verifyInstall" ] }, "examples": { "UpdateACustomIntegration": { "value": { "allowedOrigins": [], "author": "ACME Corp", "avatars": [ { "avatarType": "avatar", "avatarUuid": "6c25b771-a576-4c18-a1c3-ab059c1d42ba", "avatarUrl": "https://example.com/avatar.png", "color": false, "photoType": "icon" } ], "events": [ "issue" ], "isAlertable": false, "isDisabled": false, "metadata": "", "name": "ACME Corp Integration", "overview": null, "popularity": 27, "redirectUrl": null, "featureData": [], "schema": "", "scopes": [ "event:read", "org:read" ], "slug": "acme-corp-integration", "status": "unpublished", "uuid": "77cebea3-019e-484d-8673-6c3969698827", "verifyInstall": true, "webhookUrl": "https://example.com/webhook", "clientId": "ed06141686bb60102d878c607eff449fa9907fa7a8cb70f0d337a8fb0b6566c3", "clientSecret": "**********", "owner": { "id": 42, "slug": "acme-corp" } }, "summary": "Update a custom integration" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } }, "delete": { "operationId": "Delete a custom integration.", "description": "Delete a custom integration.", "parameters": [ { "in": "path", "name": "sentry_app_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the custom integration.", "required": true } ], "tags": [ "Integration" ], "security": [ { "auth_token": [ "org:admin" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" } } } }, "/api/0/teams/{organization_id_or_slug}/{team_id_or_slug}/": { "get": { "operationId": "Retrieve a Team", "description": "Return details on an individual team.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string" }, "description": "\nList of strings to opt in to additional data. Supports `projects`, `externalTeams`.\n" }, { "in": "query", "name": "collapse", "schema": { "type": "string" }, "description": "\nList of strings to opt out of certain pieces of data. Supports `organization`.\n" } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "team:admin", "team:read", "team:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] }, "examples": { "RetrieveATeam": { "value": { "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "dateCreated": "2018-11-06T21:19:55.114Z", "hasAccess": true, "id": "2", "isMember": true, "isPending": false, "memberCount": 1, "name": "Powerful Abolitionist", "organization": { "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "dateCreated": "2018-11-06T21:19:55.101Z", "id": "2", "isEarlyAdopter": false, "allowMemberInvite": true, "allowMemberProjectCreation": true, "allowSuperuserAccess": false, "name": "The Interstellar Jurisdiction", "require2FA": false, "slug": "the-interstellar-jurisdiction", "status": { "id": "active", "name": "active" }, "features": [ "session-replay-videos" ], "hasAuthProvider": true, "links": { "organizationUrl": "https://philosophers.sentry.io", "regionUrl": "https://us.sentry.io" } }, "slug": "powerful-abolitionist", "access": [ "event:read", "event:write", "team:read", "org:read", "project:read", "member:read", "project:releases", "alerts:read" ], "flags": { "idp:provisioned": false }, "teamRole": "contributor" }, "summary": "Retrieve a Team" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "operationId": "Update a Team", "description": "Update various attributes and configurable settings for the given\nteam.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Teams" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "slug": { "type": "string", "description": "Uniquely identifies a team. This is must be available.", "maxLength": 50, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" } }, "required": [ "slug" ] } } }, "required": true }, "security": [ { "auth_token": [ "team:admin", "team:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] }, "examples": { "UpdateATeam": { "value": { "avatar": { "avatarType": "letter_avatar" }, "dateCreated": "2018-11-06T21:20:08.115Z", "hasAccess": true, "id": "3", "isMember": false, "isPending": false, "memberCount": 1, "name": "The Inflated Philosophers", "slug": "the-inflated-philosophers", "access": [ "event:read", "event:write", "team:read", "org:read", "project:read", "member:read", "project:releases", "alerts:read" ], "flags": { "idp:provisioned": false }, "teamRole": "contributor" }, "summary": "Update a Team" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "delete": { "operationId": "Delete a Team", "description": "Schedules a team for deletion.\n\n**Note:** Deletion happens asynchronously and therefore is not\nimmediate. Teams will have their slug released while waiting for deletion.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "team:admin" ] } ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/teams/{organization_id_or_slug}/{team_id_or_slug}/external-teams/": { "post": { "operationId": "Create an External Team", "description": "Link a team from an external provider to a Sentry team.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Integrations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "external_name": { "type": "string", "description": "The associated name for the provider." }, "provider": { "enum": [ "github", "github_enterprise", "jira_server", "slack", "slack_staging", "perforce", "gitlab", "msteams", "custom_scm" ], "type": "string", "description": "The provider of the external actor.\n\n* `github`\n* `github_enterprise`\n* `jira_server`\n* `slack`\n* `slack_staging`\n* `perforce`\n* `gitlab`\n* `msteams`\n* `custom_scm`" }, "integration_id": { "type": "integer", "description": "The Integration ID." }, "external_id": { "type": "string", "nullable": true, "description": "The associated user ID for provider." } }, "required": [ "external_name", "integration_id", "provider" ] } } }, "required": true }, "security": [ { "auth_token": [ "team:admin", "team:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] }, "examples": { "CreateAnExternalTeam": { "value": { "externalId": "asdf", "externalName": "@team-foo", "provider": "slack", "integrationId": "1", "id": "1", "teamId": "2" }, "summary": "Create an external team" } } } }, "description": "" }, "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] }, "examples": { "CreateAnExternalTeam": { "value": { "externalId": "asdf", "externalName": "@team-foo", "provider": "slack", "integrationId": "1", "id": "1", "teamId": "2" }, "summary": "Create an external team" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/teams/{organization_id_or_slug}/{team_id_or_slug}/external-teams/{external_team_id}/": { "put": { "operationId": "Update an External Team", "description": "Update a team in an external provider that is currently linked to a Sentry team.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true }, { "in": "path", "name": "external_team_id", "schema": { "type": "integer" }, "description": "The ID of the external team object. This is returned when creating an external team.", "required": true } ], "tags": [ "Integrations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "external_name": { "type": "string", "description": "The associated name for the provider." }, "provider": { "enum": [ "github", "github_enterprise", "jira_server", "slack", "slack_staging", "perforce", "gitlab", "msteams", "custom_scm" ], "type": "string", "description": "The provider of the external actor.\n\n* `github`\n* `github_enterprise`\n* `jira_server`\n* `slack`\n* `slack_staging`\n* `perforce`\n* `gitlab`\n* `msteams`\n* `custom_scm`" }, "integration_id": { "type": "integer", "description": "The Integration ID." }, "external_id": { "type": "string", "nullable": true, "description": "The associated user ID for provider." } }, "required": [ "external_name", "integration_id", "provider" ] } } }, "required": true }, "security": [ { "auth_token": [ "team:admin", "team:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] }, "examples": { "CreateAnExternalTeam": { "value": { "externalId": "asdf", "externalName": "@team-foo", "provider": "slack", "integrationId": "1", "id": "1", "teamId": "2" }, "summary": "Create an external team" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } }, "delete": { "operationId": "Delete an External Team", "description": "Delete the link between a team from an external provider and a Sentry team.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true }, { "in": "path", "name": "external_team_id", "schema": { "type": "integer" }, "description": "The ID of the external team object. This is returned when creating an external team.", "required": true } ], "tags": [ "Integrations" ], "security": [ { "auth_token": [ "team:admin" ] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/0/teams/{organization_id_or_slug}/{team_id_or_slug}/members/": { "get": { "operationId": "List a Team's Members", "description": "List all members on a team.\n\nThe response will not include members with pending invites.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "team:admin", "team:read", "team:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "role": { "type": "string" }, "roleName": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true }, "teamRole": { "type": "string", "nullable": true }, "teamSlug": { "type": "string" } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "inviterName", "name", "orgRole", "pending", "teamRole", "teamSlug", "user" ] } }, "examples": { "ListTeamMembers": { "value": [ { "id": "57377908164", "email": "sirpenguin@antarcticarocks.com", "name": "Sir Penguin", "user": { "id": "280094367316", "name": "Sir Penguin", "username": "sirpenguin@antarcticarocks.com", "email": "sirpenguin@antarcticarocks.com", "avatarUrl": "https://secure.gravatar.com/avatar/16aeb26c5fdba335c7078e9e9ddb5149?s=32&d=mm", "isActive": true, "isSuspended": false, "hasPasswordAuth": true, "isManaged": false, "dateJoined": "2021-07-06T21:13:58.375239Z", "lastLogin": "2021-08-02T18:25:00.051182Z", "has2fa": false, "lastActive": "2021-08-02T21:32:18.836829Z", "isSuperuser": false, "isStaff": false, "experiments": {}, "emails": [ { "id": "2153450836", "email": "sirpenguin@antarcticarocks.com", "is_verified": true } ], "avatar": { "avatarType": "letter_avatar", "avatarUuid": null }, "canReset2fa": true }, "orgRole": "member", "pending": false, "expired": false, "flags": { "idp:provisioned": false, "idp:role-restricted": false, "sso:linked": false, "sso:invalid": false, "member-limit:restricted": false, "partnership:restricted": false }, "dateCreated": "2021-07-06T21:13:01.120263Z", "inviteStatus": "approved", "inviterName": "maininviter@antarcticarocks.com", "teamRole": "member", "teamSlug": "powerful-abolitionist" } ], "summary": "List Team Members" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/teams/{organization_id_or_slug}/{team_id_or_slug}/projects/": { "get": { "operationId": "List a Team's Projects", "description": "Return a list of projects bound to a team.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Teams" ], "security": [ { "auth_token": [ "project:admin", "project:read", "project:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "latestDeploys": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "nullable": true }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "hasUserReports": { "type": "boolean" }, "environments": { "type": "array", "items": { "type": "string" } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true } }, "required": [ "access", "dateCreated", "environments", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "hasUserReports", "id", "isBookmarked", "isMember", "latestRelease", "name", "platform", "platforms", "slug", "team", "teams" ] } }, "examples": { "GetListOfTeam'sProjects": { "value": [ { "team": { "id": "2349234102", "name": "Prime Mover", "slug": "prime-mover" }, "teams": [ { "id": "2349234102", "name": "Prime Mover", "slug": "prime-mover" }, { "id": "47584447", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" } ], "id": "6758470122493650", "slug": "the-spoiled-yoghurt", "name": "The Spoiled Yoghurt", "isBookmarked": false, "isMember": true, "access": [ "project:read", "event:read", "team:read", "alerts:read", "org:read", "event:write", "project:releases", "member:read" ], "hasAccess": true, "dateCreated": "2023-03-29T15:25:21.344565Z", "environments": [ "production" ], "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": null, "firstTransactionEvent": true, "hasSessions": false, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasMonitors": false, "hasFeedbacks": false, "hasNewFeedbacks": false, "hasMinifiedStackTrace": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": false, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": true, "hasInsightsQueues": true, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "platform": "node-express", "platforms": [], "latestRelease": null, "hasUserReports": false, "latestDeploys": null } ], "summary": "Get list of team's projects" } } } }, "description": "" }, "403": { "description": "Forbidden" }, "404": { "description": "Team not found." } } }, "post": { "operationId": "Create a New Project", "description": "Create a new project bound to a team.\n\n Note: If your organization has disabled member project creation, the `org:write` or `team:admin` scope is required.\n ", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "team_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the team the resource belongs to.", "required": true } ], "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for the project.", "maxLength": 50 }, "slug": { "type": "string", "nullable": true, "description": "Uniquely identifies a project and is used for the interface.\n If not provided, it is automatically generated from the name.", "maxLength": 100, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "platform": { "type": "string", "nullable": true, "description": "The platform for the project." }, "default_rules": { "type": "boolean", "description": "\nDefaults to true where the behavior is to alert the user on every new\nissue. Setting this to false will turn this off and the user must create\ntheir own alerts to be notified of new issues.\n " } }, "required": [ "name" ] } } }, "required": true }, "security": [ { "auth_token": [ "project:admin", "project:write" ] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "latestDeploys": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "nullable": true }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "hasUserReports": { "type": "boolean" }, "environments": { "type": "array", "items": { "type": "string" } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true } }, "required": [ "access", "dateCreated", "environments", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "hasUserReports", "id", "isBookmarked", "isMember", "latestRelease", "name", "platform", "platforms", "slug", "team", "teams" ] }, "examples": { "ProjectSuccessfullyCreated": { "value": { "team": { "id": "2349234102", "name": "Prime Mover", "slug": "prime-mover" }, "teams": [ { "id": "2349234102", "name": "Prime Mover", "slug": "prime-mover" }, { "id": "47584447", "name": "Powerful Abolitionist", "slug": "powerful-abolitionist" } ], "id": "6758470122493650", "slug": "the-spoiled-yoghurt", "name": "The Spoiled Yoghurt", "isBookmarked": false, "isMember": true, "access": [ "project:read", "event:read", "team:read", "alerts:read", "org:read", "event:write", "project:releases", "member:read" ], "hasAccess": true, "dateCreated": "2023-03-29T15:25:21.344565Z", "environments": [ "production" ], "features": [ "alert-filters", "custom-inbound-filters", "discard-groups", "minidump", "rate-limits", "servicehooks", "similarity-indexing", "similarity-indexing-v2", "similarity-view", "similarity-view-v2" ], "firstEvent": null, "firstTransactionEvent": true, "hasSessions": false, "hasProfiles": false, "hasReplays": false, "hasFlags": false, "hasMonitors": false, "hasFeedbacks": false, "hasNewFeedbacks": false, "hasMinifiedStackTrace": false, "hasInsightsHttp": true, "hasInsightsDb": false, "hasInsightsAssets": false, "hasInsightsAppStart": false, "hasInsightsScreenLoad": false, "hasInsightsVitals": false, "hasInsightsCaches": true, "hasInsightsQueues": true, "hasInsightsAgentMonitoring": false, "hasInsightsMCP": false, "hasLogs": false, "hasTraceMetrics": false, "platform": "node-express", "platforms": [], "latestRelease": null, "hasUserReports": false, "latestDeploys": null }, "summary": "Project successfully created" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Team not found." }, "409": { "description": "A project with this slug already exists." } } } }, "/api/0/organizations/{organization_id_or_slug}/repos/": { "get": { "tags": [ "Organizations" ], "description": "Return a list of version control repositories for a given organization.", "operationId": "List an Organization's Repositories", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The organization short name.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "dateCreated", "id", "name" ], "properties": { "dateCreated": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } } }, "example": [ { "dateCreated": "2018-11-06T21:19:58.536Z", "id": "3", "name": "sentry/sentry" } ] } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "org: read" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/files/dsyms/": { "get": { "tags": [ "Projects" ], "description": "Retrieve a list of debug information files for a given project.", "operationId": "List a Project's Debug Information Files", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the file belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project to list the DIFs of.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": {} } }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "project:read" ] } ] }, "post": { "tags": [ "Projects" ], "description": "Upload a new debug information file for the given release.\n\nUnlike other API requests, files must be uploaded using the\ntraditional multipart/form-data content-type.\n\nRequests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io`.\n\nThe file uploaded is a zip archive of an Apple .dSYM folder which\ncontains the individual debug images. Uploading through this endpoint\nwill create different files for the contained images.", "operationId": "Upload a New File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the project belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project to upload a file to.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The multipart encoded file." } } }, "example": { "file": "debug.zip" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": {} } }, "400": { "description": "Bad Input" }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "project:write" ] } ], "servers": [ { "url": "https://{region}.sentry.io" } ] }, "delete": { "tags": [ "Projects" ], "description": "Delete a debug information file for a given project.", "operationId": "Delete a Specific Project's Debug Information File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the file belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project to delete the DIF.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The ID of the DIF to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "project:admin", "project:releases" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/users/": { "get": { "tags": [ "Projects" ], "description": "Return a list of users seen within this project.", "operationId": "List a Project's Users", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Limit results to users matching the given query. Prefixes should be used to suggest the field to match on: `id`, `email`, `username`, `ip`. For example, `query=email:foo@example.com`", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "username", "email" ], "properties": { "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } } } }, "example": [ { "username": "sentry", "email": "sentry@example.com" } ] } } }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "project:read" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/tags/{key}/values/": { "get": { "tags": [ "Projects" ], "description": "Return a list of values associated with this key. The `query`\nparameter can be used to to perform a \"contains\" match on\nvalues. \n\nWhen [paginated](/api/pagination) can return at most 1000 values.", "operationId": "List a Tag's Values", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "description": "The tag key to look up.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } }, "example": [ { "name": "mint_choco" } ] } } }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "project:read" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/stats/": { "get": { "tags": [ "Projects" ], "summary": "Caution\nThis endpoint may change in the future without notice.", "description": "Return a set of points representing a normalized timestamp and the\nnumber of events seen in the period.\n\nQuery ranges are limited to Sentry's configured time-series resolutions.", "operationId": "Retrieve Event Counts for a Project", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "stat", "in": "query", "description": "The name of the stat to query `(\"received\", \"rejected\", \"blacklisted\", \"generated\")`.", "schema": { "type": "string", "enum": [ "received", "rejected", "blacklisted", "generated" ] } }, { "name": "since", "in": "query", "description": "A timestamp to set the start of the query in seconds since UNIX epoch.", "schema": { "type": "string", "format": "date-time" } }, { "name": "until", "in": "query", "description": "A timestamp to set the end of the query in seconds since UNIX epoch.", "schema": { "type": "string", "format": "date-time" } }, { "name": "resolution", "in": "query", "description": "An explicit resolution to search for (one of `10s`, `1h`, and `1d`).", "schema": { "type": "string", "enum": [ "10s", "1h", "1d" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "integer" } } }, "example": [ [ 1541455200, 1184 ], [ 1541458800, 1410 ], [ 1541462400, 1440 ], [ 1541466000, 1682 ], [ 1541469600, 1203 ], [ 1541473200, 497 ], [ 1541476800, 661 ], [ 1541480400, 1481 ], [ 1541484000, 678 ], [ 1541487600, 1857 ], [ 1541491200, 819 ], [ 1541494800, 1013 ], [ 1541498400, 1883 ], [ 1541502000, 1450 ], [ 1541505600, 1102 ], [ 1541509200, 1317 ], [ 1541512800, 1017 ], [ 1541516400, 813 ], [ 1541520000, 1189 ], [ 1541523600, 496 ], [ 1541527200, 1936 ], [ 1541530800, 1405 ], [ 1541534400, 617 ], [ 1541538000, 1533 ] ] } } }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "project:read" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/user-feedback/": { "get": { "tags": [ "Projects" ], "description": "Return a list of user feedback items within this project.\n\n*This list does not include submissions from the [User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget). This is because it is based on an older format called User Reports - read more [here](https://develop.sentry.dev/application/feedback-architecture/#user-reports). To return a list of user feedback items from the widget, please use the [issue API](https://docs.sentry.io/api/events/list-a-projects-issues/) with the filter `issue.category:feedback`.*", "operationId": "List a Project's User Feedback", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "comments", "dateCreated", "email", "event", "eventID", "id", "issue", "name", "user" ], "properties": { "comments": { "type": "string" }, "dateCreated": { "type": "string" }, "email": { "type": "string" }, "event": { "type": "object", "properties": { "eventID": { "type": "string" }, "id": { "type": "string", "nullable": true } } }, "eventID": { "type": "string" }, "id": { "type": "string" }, "issue": { "type": "object", "nullable": true }, "name": { "type": "string" }, "user": { "type": "object", "nullable": true } } } }, "example": [ { "comments": "It broke!", "dateCreated": "2018-11-06T21:20:11.468Z", "email": "jane@example.com", "event": { "eventID": "14bad9a2e3774046977a21440ddb39b2", "id": null }, "eventID": "14bad9a2e3774046977a21440ddb39b2", "id": "1", "issue": null, "name": "Jane Smith", "user": null } ] } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:read" ] } ] }, "post": { "tags": [ "Projects" ], "description": "*This endpoint is DEPRECATED. We document it here for older SDKs and users who are still migrating to the [User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget) or [API](https://docs.sentry.io/platforms/javascript/user-feedback/#user-feedback-api)(multi-platform). If you are a new user, do not use this endpoint - unless you don't have a JS frontend, and your platform's SDK does not offer a feedback API.*\n\nFeedback must be received by the server no more than 30 minutes after the event was saved.\n\nAdditionally, within 5 minutes of submitting feedback it may also be overwritten. This is useful in situations where you may need to retry sending a request due to network failures.\n\nIf feedback is rejected due to a mutability threshold, a 409 status code will be returned.\n\nNote: Feedback may be submitted with DSN authentication (see auth documentation).", "operationId": "Submit User Feedback", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "event_id", "name", "email", "comments" ], "type": "object", "properties": { "event_id": { "type": "string", "description": "The event ID. This can be retrieved from the [beforeSend callback](https://docs.sentry.io/platforms/javascript/configuration/filtering/#using-beforesend)." }, "name": { "type": "string", "description": "User's name." }, "email": { "type": "string", "description": "User's email address." }, "comments": { "type": "string", "description": "Comments supplied by user." } } }, "example": { "event_id": "14bad9a2e3774046977a21440ddb39b2", "name": "Jane Schmidt", "email": "jane@empowerplant.io", "comments": "It broke!" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "comments", "dateCreated", "email", "event", "eventID", "id", "issue", "name", "user" ], "properties": { "comments": { "type": "string" }, "dateCreated": { "type": "string" }, "email": { "type": "string" }, "event": { "type": "object", "properties": { "eventID": { "type": "string" }, "id": { "type": "string", "nullable": true } } }, "eventID": { "type": "string" }, "id": { "type": "string" }, "issue": { "type": "object", "nullable": true }, "name": { "type": "string" }, "user": { "type": "object", "nullable": true } } }, "example": { "comments": "It broke!", "dateCreated": "2018-11-06T21:20:11.468Z", "email": "jane@example.com", "event": { "eventID": "14bad9a2e3774046977a21440ddb39b2", "id": null }, "eventID": "14bad9a2e3774046977a21440ddb39b2", "id": "1", "issue": null, "name": "Jane Smith", "user": null } } } }, "400": { "description": "Bad Input" }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" }, "409": { "description": "Conflict" } }, "security": [ { "auth_token": [ "project:write" ] }, { "dsn": [] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/": { "get": { "tags": [ "Projects" ], "description": "Return a list of service hooks bound to a project.", "operationId": "List a Project's Service Hooks", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "dateCreated", "events", "id", "secret", "status", "url" ], "properties": { "dateCreated": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "secret": { "type": "string" }, "status": { "type": "string" }, "url": { "type": "string" } } } }, "example": [ { "dateCreated": "2018-11-06T21:20:08.143Z", "events": [ "event.alert", "event.created" ], "id": "4f9d73e63b7144ecb8944c41620a090b", "secret": "8fcac28aaa4c4f5fa572b61d40a8e084364db25fd37449c299e5a41c0504cbc2", "status": "active", "url": "https://empowerplant.io/sentry-hook" } ] } } }, "403": { "description": "You do not have that feature enabled" } }, "security": [ { "auth_token": [ "project:read" ] } ] }, "post": { "tags": [ "Projects" ], "description": "Register a new service hook on a project.\n\nEvents include:\n\n- event.alert: An alert is generated for an event (via rules).\n- event.created: A new event has been processed.\n\nThis endpoint requires the 'servicehooks' feature to be enabled for your project.", "operationId": "Register a New Service Hook", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the client keys belong to.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "url", "events" ], "type": "object", "properties": { "url": { "type": "string", "description": "The URL for the webhook." }, "events": { "type": "array", "description": "The events to subscribe to.", "items": { "type": "string" } } } }, "example": { "url": "https://empowerplant.io/sentry-hook", "events": [ "event.alert", "event.created" ] } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "dateCreated", "events", "id", "secret", "status", "url" ], "properties": { "dateCreated": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "secret": { "type": "string" }, "status": { "type": "string" }, "url": { "type": "string" } } }, "example": { "dateCreated": "2018-11-06T21:20:08.143Z", "events": [ "event.alert", "event.created" ], "id": "4f9d73e63b7144ecb8944c41620a090b", "secret": "8fcac28aaa4c4f5fa572b61d40a8e084364db25fd37449c299e5a41c0504cbc2", "status": "active", "url": "https://empowerplant.io/sentry-hook" } } } }, "403": { "description": "You do not have that feature enabled" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "project:write" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/{hook_id}/": { "get": { "tags": [ "Projects" ], "description": "Return a service hook bound to a project.", "operationId": "Retrieve a Service Hook", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "in": "path", "description": "The GUID of the service hook.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "dateCreated", "events", "id", "secret", "status", "url" ], "properties": { "dateCreated": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "secret": { "type": "string" }, "status": { "type": "string" }, "url": { "type": "string" } } }, "example": { "dateCreated": "2018-11-06T21:20:08.143Z", "events": [ "event.alert", "event.created" ], "id": "4f9d73e63b7144ecb8944c41620a090b", "secret": "8fcac28aaa4c4f5fa572b61d40a8e084364db25fd37449c299e5a41c0504cbc2", "status": "active", "url": "https://empowerplant.io/sentry-hook" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "project:read" ] } ] }, "put": { "tags": [ "Projects" ], "description": "Update a service hook.", "operationId": "Update a Service Hook", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "in": "path", "description": "The GUID of the service hook.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "url", "events" ], "type": "object", "properties": { "url": { "type": "string", "description": "The URL for the webhook." }, "events": { "type": "array", "description": "The events to subscribe to.", "items": { "type": "string" } } } }, "example": { "url": "https://empowerplant.io/sentry-hook", "events": [ "event.alert", "event.created" ] } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "dateCreated", "events", "id", "secret", "status", "url" ], "properties": { "dateCreated": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "secret": { "type": "string" }, "status": { "type": "string" }, "url": { "type": "string" } } }, "example": { "dateCreated": "2018-11-06T21:20:08.143Z", "events": [ "event.alert", "event.created" ], "id": "4f9d73e63b7144ecb8944c41620a090b", "secret": "8fcac28aaa4c4f5fa572b61d40a8e084364db25fd37449c299e5a41c0504cbc2", "status": "active", "url": "https://empowerplant.io/sentry-hook" } } } }, "400": { "description": "Bad Input" }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "project:write" ] } ] }, "delete": { "tags": [ "Projects" ], "description": "Remove a service hook.", "operationId": "Remove a Service Hook", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the client keys belong to.", "required": true, "schema": { "type": "string" } }, { "name": "hook_id", "in": "path", "description": "The GUID of the service hook.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "project:admin" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/": { "get": { "tags": [ "Events" ], "description": "Return details on an individual event.", "operationId": "Retrieve an Event for a Project", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the event belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the event belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "event_id", "in": "path", "description": "The ID of the event to retrieve. It is the hexadecimal ID as reported by the client.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "eventID", "dist", "userReport", "previousEventID", "message", "id", "size", "errors", "platform", "nextEventID", "type", "metadata", "tags", "dateCreated", "dateReceived", "user", "entries", "packages", "sdk", "_meta", "contexts", "fingerprints", "context", "release", "groupID", "title" ], "properties": { "eventID": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "userReport": { "type": "object", "nullable": true }, "previousEventID": { "type": "string", "nullable": true }, "message": { "type": "string" }, "id": { "type": "string" }, "size": { "type": "integer" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "data": { "type": "object", "properties": { "column": { "type": "integer" }, "source": { "type": "string" }, "row": { "type": "integer" } } } } } }, "platform": { "type": "string" }, "nextEventID": { "type": "string", "nullable": true }, "type": { "type": "string" }, "metadata": { "oneOf": [ { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string" }, "value": { "type": "string" } } }, { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string" } } } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" }, "_meta": { "type": "string", "nullable": true } } } }, "dateCreated": { "type": "string" }, "dateReceived": { "type": "string" }, "user": { "type": "object", "nullable": true, "required": [ "username", "name", "ip_address", "email", "data", "id" ], "properties": { "username": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true, "properties": { "isStaff": { "type": "boolean" } } }, "id": { "type": "string" } } }, "entries": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "type": "string" }, "data": { "type": "object", "required": [ "values" ], "properties": { "values": { "type": "array", "items": { "type": "object", "required": [ "category", "level", "event_id", "timestamp", "data", "message", "type" ], "properties": { "category": { "type": "string" }, "level": { "type": "string" }, "event_id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "data": { "type": "object", "nullable": true }, "message": { "type": "string", "nullable": true }, "type": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "type": "string" }, "data": { "type": "object", "required": [ "fragment", "cookies", "inferredContentType", "env", "headers", "url", "query", "data", "method" ], "properties": { "fragment": { "type": "string", "nullable": true }, "cookies": { "type": "array", "nullable": true, "items": { "type": "array", "items": { "type": "string" } } }, "inferredContentType": { "type": "string", "nullable": true }, "env": { "type": "object", "nullable": true, "properties": { "ENV": { "type": "string" } } }, "headers": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "url": { "type": "string" }, "query": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "data": { "type": "object", "nullable": true }, "method": { "type": "string", "nullable": true } } } } }, { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "type": "string" }, "data": { "type": "object", "required": [ "formatted" ], "properties": { "formatted": { "type": "string" } } } } }, { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "type": "string" }, "data": { "type": "object", "required": [ "excOmitted", "hasSystemFrames", "values" ], "properties": { "excOmitted": { "type": "array", "nullable": true, "items": { "type": "integer" } }, "hasSystemFrames": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "object", "required": [ "stacktrace", "module", "rawStacktrace", "mechanism", "threadId", "value", "type" ], "properties": { "stacktrace": { "type": "object", "nullable": true, "required": [ "frames", "framesOmitted", "registers", "hasSystemFrames" ], "properties": { "frames": { "type": "array", "items": { "type": "object", "required": [ "function", "errors", "colNo", "vars", "package", "absPath", "inApp", "lineNo", "module", "filename", "platform", "instructionAddr", "context", "symbolAddr", "trust", "symbol" ], "properties": { "function": { "type": "string" }, "errors": { "type": "string", "nullable": true }, "colNo": { "type": "integer", "nullable": true }, "vars": { "type": "object", "nullable": true }, "package": { "type": "string", "nullable": true }, "absPath": { "type": "string", "nullable": true }, "inApp": { "type": "boolean" }, "lineNo": { "type": "integer" }, "module": { "type": "string" }, "filename": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "instructionAddr": { "type": "string", "nullable": true }, "context": { "type": "array", "items": { "type": "array", "items": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } } }, "symbolAddr": { "type": "string", "nullable": true }, "trust": { "type": "string", "nullable": true }, "symbol": { "type": "string", "nullable": true } } } }, "framesOmitted": { "type": "string", "nullable": true }, "registers": { "type": "string", "nullable": true }, "hasSystemFrames": { "type": "boolean" } } }, "module": { "type": "string", "nullable": true }, "rawStacktrace": { "type": "object", "nullable": true }, "mechanism": { "type": "object", "nullable": true, "properties": { "type": { "type": "string" }, "handled": { "type": "boolean" } } }, "threadId": { "type": "string", "nullable": true }, "value": { "type": "string" }, "type": { "type": "string" } } } } } } } } ] } }, "packages": { "type": "object" }, "sdk": { "type": "object", "properties": { "version": { "type": "string" }, "name": { "type": "string" } } }, "_meta": { "type": "object", "properties": { "user": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "entries": { "type": "object" }, "contexts": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "packages": { "type": "string", "nullable": true }, "tags": { "type": "object" }, "sdk": { "type": "string", "nullable": true } } }, "contexts": { "type": "object", "properties": { "ForbiddenError": { "type": "object", "properties": { "status": { "type": "integer" }, "statusText": { "type": "string" }, "responseJSON": { "type": "object", "properties": { "detail": { "type": "string" } } }, "type": { "type": "string" } } }, "browser": { "type": "object", "properties": { "version": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" } } }, "os": { "type": "object", "properties": { "version": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" } } }, "trace": { "type": "object", "properties": { "span_id": { "type": "string" }, "type": { "type": "string" }, "trace_id": { "type": "string" }, "op": { "type": "string" } } }, "organization": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "slug": { "type": "string" } } } } }, "fingerprints": { "type": "array", "items": { "type": "string" } }, "context": { "type": "object", "properties": { "resp": { "type": "object", "properties": { "status": { "type": "integer" }, "responseJSON": { "type": "object", "properties": { "detail": { "type": "string" } } }, "name": { "type": "string" }, "statusText": { "type": "string" }, "message": { "type": "string" }, "stack": { "type": "string" } } }, "session": { "type": "object", "properties": { "foo": { "type": "string" } } }, "unauthorized": { "type": "boolean" }, "url": { "type": "string" } } }, "release": { "type": "object", "nullable": true, "allOf": [ { "type": "object", "required": [ "authors", "commitCount", "data", "dateCreated", "dateReleased", "deployCount", "firstEvent", "lastCommit", "lastDeploy", "lastEvent", "newGroups", "owner", "projects", "ref", "shortVersion", "version", "url" ], "properties": { "id": { "type": "integer" }, "authors": { "type": "array", "items": { "type": "object" } }, "commitCount": { "type": "integer", "format": "int64" }, "data": { "type": "object" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "deployCount": { "type": "integer", "format": "int64" }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "lastCommit": { "type": "object", "nullable": true }, "lastDeploy": { "type": "object", "nullable": true, "oneOf": [ { "type": "object", "required": [ "environment", "name", "dateStarted", "dateFinished", "url", "id" ], "properties": { "environment": { "type": "string" }, "name": { "type": "string", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "dateFinished": { "type": "string", "format": "date-time" }, "url": { "type": "string", "nullable": true }, "id": { "type": "string" } } }, { "type": "string", "nullable": true, "not": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object" }, { "type": "array", "items": {} } ] } } ] }, "lastEvent": { "type": "string", "format": "date-time", "nullable": true }, "newGroups": { "type": "integer", "format": "int64" }, "owner": { "type": "object", "nullable": true }, "projects": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } } } }, "ref": { "type": "string", "nullable": true }, "shortVersion": { "type": "string" }, "version": { "type": "string" }, "url": { "type": "string", "nullable": true } } } ] }, "groupID": { "type": "string" }, "title": { "type": "string" } } }, "example": { "eventID": "9999aaaaca8b46d797c23c6077c6ff01", "dist": null, "userReport": null, "previousEventID": null, "message": "", "title": "This is an example Python exception", "id": "9999aaafcc8b46d797c23c6077c6ff01", "size": 107762, "errors": [ { "data": { "column": 8, "source": "https://s1.sentry-cdn.com/_static/bloopbloop/sentry/dist/app.js.map", "row": 15 }, "message": "Invalid location in sourcemap", "type": "js_invalid_sourcemap_location" } ], "platform": "javascript", "nextEventID": "99f9e199e9a74a14bfef6196ad741619", "type": "error", "metadata": { "type": "ForbiddenError", "value": "GET /organizations/hellboy-meowmeow/users/ 403" }, "tags": [ { "value": "Chrome 83.0.4103", "key": "browser", "_meta": null }, { "value": "Chrome", "key": "browser.name", "_meta": null }, { "value": "prod", "key": "environment", "_meta": null }, { "value": "yes", "key": "handled", "_meta": null }, { "value": "error", "key": "level", "_meta": null }, { "value": "generic", "key": "mechanism", "_meta": null } ], "dateCreated": "2020-06-17T22:26:56.098086Z", "dateReceived": "2020-06-17T22:26:56.428721Z", "user": { "username": null, "name": "Hell Boy", "ip_address": "192.168.1.1", "email": "hell@boy.cat", "data": { "isStaff": false }, "id": "550747" }, "entries": [ { "type": "exception", "data": { "values": [ { "stacktrace": { "frames": [ { "function": "ignoreOnError", "errors": null, "colNo": 23, "vars": null, "package": null, "absPath": "webpack:////usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers.js", "inApp": false, "lineNo": 71, "module": "usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers", "filename": "/usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers.js", "platform": null, "instructionAddr": null, "context": [ [ 66, " }" ], [ 67, " // Attempt to invoke user-land function" ], [ 68, " // NOTE: If you are a Sentry user, and you are seeing this stack frame, it" ], [ 69, " // means the sentry.javascript SDK caught an error invoking your application code. This" ], [ 70, " // is expected behavior and NOT indicative of a bug with sentry.javascript." ], [ 71, " return fn.apply(this, wrappedArguments);" ], [ 72, " // tslint:enable:no-unsafe-any" ], [ 73, " }" ], [ 74, " catch (ex) {" ], [ 75, " ignoreNextOnError();" ], [ 76, " withScope(function (scope) {" ] ], "symbolAddr": null, "trust": null, "symbol": null }, { "function": "apply", "errors": null, "colNo": 24, "vars": null, "package": null, "absPath": "webpack:////usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods.js", "inApp": false, "lineNo": 74, "module": "usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods", "filename": "/usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods.js", "platform": null, "instructionAddr": null, "context": [ [ 69, " */" ], [ 70, " triggerAsync: function triggerAsync() {" ], [ 71, " var args = arguments," ], [ 72, " me = this;" ], [ 73, " _.nextTick(function () {" ], [ 74, " me.trigger.apply(me, args);" ], [ 75, " });" ], [ 76, " }," ], [ 77, "" ], [ 78, " /**" ], [ 79, " * Wraps the trigger mechanism with a deferral function." ] ], "symbolAddr": null, "trust": null, "symbol": null } ], "framesOmitted": null, "registers": null, "hasSystemFrames": true }, "module": null, "rawStacktrace": { "frames": [ { "function": "a", "errors": null, "colNo": 88800, "vars": null, "package": null, "absPath": "https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "inApp": false, "lineNo": 81, "module": null, "filename": "/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "platform": null, "instructionAddr": null, "context": [ [ 76, "/*!" ], [ 77, " Copyright (c) 2018 Jed Watson." ], [ 78, " Licensed under the MIT License (MIT), see" ], [ 79, " http://jedwatson.github.io/react-select" ], [ 80, "*/" ], [ 81, "{snip} e,t)}));return e.handleEvent?e.handleEvent.apply(this,s):e.apply(this,s)}catch(e){throw c(),Object(o.m)((function(n){n.addEventProcessor((fu {snip}" ], [ 82, "/*!" ], [ 83, " * JavaScript Cookie v2.2.1" ], [ 84, " * https://github.com/js-cookie/js-cookie" ], [ 85, " *" ], [ 86, " * Copyright 2006, 2015 Klaus Hartl & Fagner Brack" ] ], "symbolAddr": null, "trust": null, "symbol": null }, { "function": null, "errors": null, "colNo": 149484, "vars": null, "package": null, "absPath": "https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "inApp": false, "lineNo": 119, "module": null, "filename": "/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "platform": null, "instructionAddr": null, "context": [ [ 114, "/* @license" ], [ 115, "Papa Parse" ], [ 116, "v5.2.0" ], [ 117, "https://github.com/mholt/PapaParse" ], [ 118, "License: MIT" ], [ 119, "{snip} (){var e=arguments,t=this;r.nextTick((function(){t.trigger.apply(t,e)}))},deferWith:function(e){var t=this.trigger,n=this,r=function(){t.app {snip}" ], [ 120, "/**!" ], [ 121, " * @fileOverview Kickass library to create and place poppers near their reference elements." ], [ 122, " * @version 1.16.1" ], [ 123, " * @license" ], [ 124, " * Copyright (c) 2016 Federico Zivolo and contributors" ] ], "symbolAddr": null, "trust": null, "symbol": null } ], "framesOmitted": null, "registers": null, "hasSystemFrames": true }, "mechanism": { "type": "generic", "handled": true }, "threadId": null, "value": "GET /organizations/hellboy-meowmeow/users/ 403", "type": "ForbiddenError" } ], "excOmitted": null, "hasSystemFrames": true } }, { "type": "breadcrumbs", "data": { "values": [ { "category": "tracing", "level": "debug", "event_id": null, "timestamp": "2020-06-17T22:26:55.266586Z", "data": null, "message": "[Tracing] pushActivity: idleTransactionStarted#1", "type": "debug" }, { "category": "xhr", "level": "info", "event_id": null, "timestamp": "2020-06-17T22:26:55.619446Z", "data": { "url": "/api/0/internal/health/", "status_code": 200, "method": "GET" }, "message": null, "type": "http" }, { "category": "sentry.transaction", "level": "info", "event_id": null, "timestamp": "2020-06-17T22:26:55.945016Z", "data": null, "message": "7787a027f3fb46c985aaa2287b3f4d09", "type": "default" } ] } }, { "type": "request", "data": { "fragment": null, "cookies": [], "inferredContentType": null, "env": null, "headers": [ [ "User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.97 Safari/537.36" ] ], "url": "https://sentry.io/organizations/hellboy-meowmeow/issues/", "query": [ [ "project", "5236886" ] ], "data": null, "method": null } } ], "packages": {}, "sdk": { "version": "5.17.0", "name": "sentry.javascript.browser" }, "_meta": { "user": null, "context": null, "entries": {}, "contexts": null, "message": null, "packages": null, "tags": {}, "sdk": null }, "contexts": { "ForbiddenError": { "status": 403, "statusText": "Forbidden", "responseJSON": { "detail": "You do not have permission to perform this action." }, "type": "default" }, "browser": { "version": "83.0.4103", "type": "browser", "name": "Chrome" }, "os": { "version": "10", "type": "os", "name": "Windows" }, "trace": { "span_id": "83db1ad17e67dfe7", "type": "trace", "trace_id": "da6caabcd90e45fdb81f6655824a5f88", "op": "navigation" }, "organization": { "type": "default", "id": "323938", "slug": "hellboy-meowmeow" } }, "fingerprints": [ "fbe908cc63d63ea9763fd84cb6bad177" ], "context": { "resp": { "status": 403, "responseJSON": { "detail": "You do not have permission to perform this action." }, "name": "ForbiddenError", "statusText": "Forbidden", "message": "GET /organizations/hellboy-meowmeow/users/ 403", "stack": "Error\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480441\n at u (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:51006)\n at Generator._invoke (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:50794)\n at Generator.A.forEach.e. [as next] (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:51429)\n at n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68684)\n at s (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68895)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68954\n at new Promise ()\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68835\n at v (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480924)\n at m (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480152)\n at t.fetchMemberList (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:902983)\n at t.componentDidMount (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:900527)\n at t.componentDidMount (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:15597)\n at Pc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:101023)\n at t.unstable_runWithPriority (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:3462)\n at Ko (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45529)\n at Rc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:97371)\n at Oc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:87690)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45820\n at t.unstable_runWithPriority (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:3462)\n at Ko (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45529)\n at Zo (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45765)\n at Jo (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45700)\n at gc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:84256)\n at Object.enqueueSetState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:50481)\n at t.M.setState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:173:1439)\n at t.onUpdate (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:543076)\n at a.n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149090)\n at a.emit (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:6550)\n at p.trigger (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149379)\n at p.onInitializeUrlState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:541711)\n at a.n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149090)\n at a.emit (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:6550)\n at Function.trigger (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149379)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149484\n at a (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:81:88800)" } }, "release": { "dateReleased": "2020-06-17T19:21:02.186004Z", "newGroups": 4, "commitCount": 11, "url": "https://freight.getsentry.net/deploys/getsentry/production/8868/", "data": {}, "lastDeploy": { "name": "b65bc521378269d3eaefdc964f8ef56621414943 to prod", "url": null, "environment": "prod", "dateStarted": null, "dateFinished": "2020-06-17T19:20:55.641748Z", "id": "6883490" }, "deployCount": 1, "dateCreated": "2020-06-17T18:45:31.042157Z", "lastEvent": "2020-07-08T21:21:21Z", "version": "b65bc521378269d3eaefdc964f8ef56621414943", "firstEvent": "2020-06-17T22:25:14Z", "lastCommit": { "repository": { "status": "active", "integrationId": "2933", "externalSlug": "getsentry/getsentry", "name": "getsentry/getsentry", "provider": { "id": "integrations:github", "name": "GitHub" }, "url": "https://github.com/getsentry/getsentry", "id": "2", "dateCreated": "2016-10-10T21:36:45.373994Z" }, "releases": [ { "dateReleased": "2020-06-23T13:26:18.427090Z", "url": "https://freight.getsentry.net/deploys/getsentry/staging/2077/", "dateCreated": "2020-06-23T13:22:50.420265Z", "version": "f3783e5fe710758724f14267439fd46cc2bf5918", "shortVersion": "f3783e5fe710758724f14267439fd46cc2bf5918", "ref": "perf/source-maps-test" }, { "dateReleased": "2020-06-17T19:21:02.186004Z", "url": "https://freight.getsentry.net/deploys/getsentry/production/8868/", "dateCreated": "2020-06-17T18:45:31.042157Z", "version": "b65bc521378269d3eaefdc964f8ef56621414943", "shortVersion": "b65bc521378269d3eaefdc964f8ef56621414943", "ref": "master" } ], "dateCreated": "2020-06-17T18:43:37Z", "message": "feat(billing): Get a lot of money", "id": "b65bc521378269d3eaefdc964f8ef56621414943" }, "shortVersion": "b65bc521378269d3eaefdc964f8ef56621414943", "authors": [ { "username": "a37a1b4520ce46cea147ae2885a4e7e7", "lastLogin": "2020-09-14T22:34:55.550640Z", "isSuperuser": false, "isManaged": false, "experiments": {}, "lastActive": "2020-09-15T22:13:20.503880Z", "isStaff": false, "id": "655784", "isActive": true, "has2fa": false, "name": "hell.boy@sentry.io", "avatarUrl": "https://secure.gravatar.com/avatar/eaa22e25b3a984659420831a77e4874e?s=32&d=mm", "dateJoined": "2020-04-20T16:21:25.365772Z", "emails": [ { "is_verified": false, "id": "784574", "email": "hellboy@gmail.com" }, { "is_verified": true, "id": "749185", "email": "hell.boy@sentry.io" } ], "avatar": { "avatarUuid": null, "avatarType": "letter_avatar" }, "hasPasswordAuth": false, "email": "hell.boy@sentry.io" } ], "owner": null, "ref": "master", "projects": [ { "name": "Sentry CSP", "slug": "sentry-csp" }, { "name": "Backend", "slug": "sentry" }, { "name": "Frontend", "slug": "javascript" } ] }, "groupID": "1341191803" } } } }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "project:read" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/issues/": { "get": { "tags": [ "Events" ], "description": "**Deprecated**: This endpoint has been replaced with the [Organization Issues endpoint](/api/events/list-an-organizations-issues/) which\nsupports filtering on project and additional functionality.\n\nReturn a list of issues (groups) bound to a project. All parameters are supplied as query string parameters. \n\n A default query of ``is:unresolved`` is applied. To return results with other statuses send an new query value (i.e. ``?query=`` for all results).\n\nThe ``statsPeriod`` parameter can be used to select the timeline stats which should be present. Possible values are: ``\"\"`` (disable),``\"24h\"`` (default), ``\"14d\"``\n\nUser feedback items from the [User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget) are built off the issue platform, so to return a list of user feedback items for a specific project, filter for `issue.category:feedback`.", "operationId": "List a Project's Issues", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the issues belong to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the issues belong to.", "required": true, "schema": { "type": "string" } }, { "name": "statsPeriod", "in": "query", "description": "An optional stat period (can be one of `\"24h\"`, `\"14d\"`, and `\"\"`), defaults to \"24h\" if not provided.", "schema": { "type": "string" } }, { "name": "shortIdLookup", "in": "query", "description": "If this is set to true then short IDs are looked up by this function as well. This can cause the return value of the function to return an event issue of a different project which is why this is an opt-in. Set to 1 to enable.", "schema": { "type": "boolean" } }, { "name": "query", "in": "query", "description": "An optional Sentry structured search query. If not provided an implied `\"is:unresolved\"` is assumed.", "schema": { "type": "string" } }, { "name": "hashes", "in": "query", "description": "A list of hashes of groups to return. Is not compatible with 'query' parameter. The maximum number of hashes that can be sent is 100. If more are sent, only the first 100 will be used.", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "lastSeen", "numComments", "userCount", "culprit", "title", "id", "assignedTo", "logger", "stats", "type", "annotations", "metadata", "status", "subscriptionDetails", "isPublic", "hasSeen", "shortId", "shareId", "firstSeen", "count", "permalink", "level", "isSubscribed", "isBookmarked", "project", "statusDetails" ], "properties": { "annotations": { "type": "array", "items": { "type": "string" } }, "assignedTo": { "type": "object", "nullable": true }, "count": { "type": "string" }, "culprit": { "type": "string" }, "firstSeen": { "type": "string" }, "hasSeen": { "type": "boolean" }, "id": { "type": "string" }, "isBookmarked": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "lastSeen": { "type": "string" }, "level": { "type": "string" }, "logger": { "type": "string", "nullable": true }, "metadata": { "oneOf": [ { "type": "object", "required": [ "filename", "type", "value" ], "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } } }, { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string" } } } ] }, "numComments": { "type": "integer" }, "permalink": { "type": "string" }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "shareId": { "type": "string", "nullable": true }, "shortId": { "type": "string" }, "stats": { "type": "object", "properties": { "24h": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } } } }, "status": { "type": "string", "enum": [ "resolved", "unresolved", "ignored" ] }, "statusDetails": { "type": "object" }, "subscriptionDetails": { "type": "object", "nullable": true }, "title": { "type": "string" }, "type": { "type": "string" }, "userCount": { "type": "integer" } } } }, "example": [ { "annotations": [], "assignedTo": null, "count": "1", "culprit": "raven.scripts.runner in main", "firstSeen": "2018-11-06T21:19:55Z", "hasSeen": false, "id": "1", "isBookmarked": false, "isPublic": false, "isSubscribed": true, "lastSeen": "2018-11-06T21:19:55Z", "level": "error", "logger": null, "metadata": { "title": "This is an example Python exception" }, "numComments": 0, "permalink": "https://sentry.io/the-interstellar-jurisdiction/pump-station/issues/1/", "project": { "id": "2", "name": "Pump Station", "slug": "pump-station" }, "shareId": null, "shortId": "PUMP-STATION-1", "stats": { "24h": [ [ 1541455200, 473 ], [ 1541458800, 914 ], [ 1541462400, 991 ], [ 1541466000, 925 ], [ 1541469600, 881 ], [ 1541473200, 182 ], [ 1541476800, 490 ], [ 1541480400, 820 ], [ 1541484000, 322 ], [ 1541487600, 836 ], [ 1541491200, 565 ], [ 1541494800, 758 ], [ 1541498400, 880 ], [ 1541502000, 677 ], [ 1541505600, 381 ], [ 1541509200, 814 ], [ 1541512800, 329 ], [ 1541516400, 446 ], [ 1541520000, 731 ], [ 1541523600, 111 ], [ 1541527200, 926 ], [ 1541530800, 772 ], [ 1541534400, 400 ], [ 1541538000, 943 ] ] }, "status": "unresolved", "statusDetails": {}, "subscriptionDetails": null, "title": "This is an example Python exception", "type": "default", "userCount": 0 } ] } } }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "event:read" ] } ] }, "put": { "tags": [ "Events" ], "description": "Bulk mutate various attributes on issues. The list of issues to modify is given through the `id` query parameter. It is repeated for each issue that should be modified.\n\n- For non-status updates, the `id` query parameter is required.\n- For status updates, the `id` query parameter may be omitted\nfor a batch \"update all\" query.\n- An optional `status` query parameter may be used to restrict\nmutations to only events with the given status.\n\nThe following attributes can be modified and are supplied as JSON object in the body:\n\nIf any IDs are out of scope this operation will succeed without any data mutation.", "operationId": "Bulk Mutate a List of Issues", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the issues belong to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the issues belong to.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "A list of IDs of the issues to be mutated. This parameter shall be repeated for each issue. It is optional only if a status is mutated in which case an implicit update all is assumed.", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "Optionally limits the query to issues of the specified status. Valid values are `\"resolved\"`, `\"reprocessing\"`, `\"unresolved\"`, and `\"ignored\"`.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "The new status for the issues. Valid values are `\"resolved\"`, `\"resolvedInNextRelease\"`, `\"unresolved\"`, and `\"ignored\"`." }, "statusDetails": { "type": "object", "properties": { "inRelease": { "type": "string" }, "inNextRelease": { "type": "boolean" }, "inCommit": { "type": "string" }, "ignoreDuration": { "type": "integer" }, "ignoreCount": { "type": "integer" }, "ignoreWindow": { "type": "integer" }, "ignoreUserCount": { "type": "integer" }, "ignoreUserWindow": { "type": "integer" } }, "description": "Additional details about the resolution. Valid values are `\"inRelease\"`, `\"inNextRelease\"`, `\"inCommit\"`, `\"ignoreDuration\"`, `\"ignoreCount\"`, `\"ignoreWindow\"`, `\"ignoreUserCount\"`, and `\"ignoreUserWindow\"`." }, "ignoreDuration": { "type": "integer", "description": "The number of minutes to ignore this issue." }, "isPublic": { "type": "boolean", "description": "Sets the issue to public or private." }, "merge": { "type": "boolean", "description": "Allows to merge or unmerge different issues." }, "assignedTo": { "type": "string", "description": "The actor ID (or username) of the user or team that should be assigned to this issue." }, "hasSeen": { "type": "boolean", "description": "In case this API call is invoked with a user context this allows changing of the flag that indicates if the user has seen the event." }, "isBookmarked": { "type": "boolean", "description": "In case this API call is invoked with a user context this allows changing of the bookmark flag." } } }, "example": { "isPublic": false, "status": "unresolved" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "isPublic", "status", "statusDetails" ], "properties": { "isPublic": { "type": "boolean" }, "status": { "type": "string", "enum": [ "resolved", "unresolved", "ignored" ] }, "statusDetails": { "type": "object" } } }, "example": { "isPublic": false, "status": "unresolved", "statusDetails": {} } } } }, "400": { "description": "Bad Input" }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "event:write" ] } ] }, "delete": { "tags": [ "Events" ], "description": "Permanently remove the given issues. The list of issues to modify is given through the `id` query parameter. It is repeated for each issue that should be removed.\n\nOnly queries by 'id' are accepted.\n\nIf any IDs are out of scope this operation will succeed without any data mutation.", "operationId": "Bulk Remove a List of Issues", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the issues belong to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the issues belong to.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "A list of IDs of the issues to be removed. This parameter shall be repeated for each issue, e.g. `?id=1&id=2&id=3`. If this parameter is not provided, it will attempt to remove the first 1000 issues.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "Project not found" } }, "security": [ { "auth_token": [ "event:admin" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/tags/{key}/values/": { "get": { "operationId": "List a Tag's Values for an Issue", "description": "Returns a list of values associated with this key for an issue.\nReturns at most 1000 values when paginated.", "parameters": [ { "in": "path", "name": "issue_id", "schema": { "type": "integer" }, "description": "The ID of the issue you'd like to query.", "required": true }, { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "key", "schema": { "type": "string" }, "description": "The tag key to look the values up for.", "required": true }, { "in": "query", "name": "sort", "schema": { "type": "string", "enum": [ "age", "count", "date", "id" ] }, "description": "Sort order of the resulting tag values. Prefix with '-' for descending order. Default is '-id'." }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." } ], "tags": [ "Events" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "key": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string", "nullable": true }, "count": { "type": "integer", "nullable": true }, "lastSeen": { "type": "string", "nullable": true }, "firstSeen": { "type": "string", "nullable": true } }, "required": [ "count", "firstSeen", "key", "lastSeen", "name", "value" ] } }, "examples": { "ReturnAllTagValuesForASpecificTag": { "value": [ { "key": "strawberry", "name": "Strawberry", "value": "strawberry", "count": 2, "lastSeen": "2024-01-01T00:00:00Z", "firstSeen": "2024-01-01T00:00:00Z" }, { "key": "vanilla", "name": "Vanilla", "value": "vanilla", "count": 1, "lastSeen": "2024-01-01T00:00:00Z", "firstSeen": "2024-01-01T00:00:00Z" }, { "key": "chocolate", "name": "Chocolate", "value": "chocolate", "count": 1, "lastSeen": "2024-01-01T00:00:00Z", "firstSeen": "2024-01-01T00:00:00Z" }, { "key": "Neopolitan", "name": "Neopolitan", "value": "neopolitan", "count": 1, "lastSeen": "2024-01-01T00:00:00Z", "firstSeen": "2024-01-01T00:00:00Z" } ], "summary": "Return all tag values for a specific tag" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/hashes/": { "get": { "tags": [ "Events" ], "description": "This endpoint lists an issue's hashes, which are the generated checksums used to aggregate individual events.", "operationId": "List an Issue's Hashes", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the event belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "issue_id", "in": "path", "description": "The ID of the issue to retrieve.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "full", "schema": { "type": "boolean", "default": true }, "description": "If this is set to true, the event payload will include the full event body, including the stacktrace. Set to 1 to enable.", "required": false }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "latestEvent": { "type": "object", "required": [ "eventID", "dist", "message", "id", "size", "errors", "platform", "type", "metadata", "tags", "dateCreated", "dateReceived", "user", "entries", "packages", "sdk", "_meta", "contexts", "fingerprints", "context", "groupID", "title" ], "properties": { "eventID": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "message": { "type": "string" }, "id": { "type": "string" }, "size": { "type": "integer" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "data": { "type": "object", "properties": { "column": { "type": "integer" }, "source": { "type": "string" }, "row": { "type": "integer" } } } } } }, "platform": { "type": "string" }, "type": { "type": "string" }, "metadata": { "oneOf": [ { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string" }, "value": { "type": "string" } } }, { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string" } } } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" }, "_meta": { "type": "string", "nullable": true } } } }, "dateCreated": { "type": "string" }, "dateReceived": { "type": "string" }, "user": { "type": "object", "nullable": true, "required": [ "username", "name", "ip_address", "email", "data", "id" ], "properties": { "username": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true, "properties": { "isStaff": { "type": "boolean" } } }, "id": { "type": "string" } } }, "entries": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "type": "string" }, "data": { "type": "object", "required": [ "values" ], "properties": { "values": { "type": "array", "items": { "type": "object", "required": [ "category", "level", "event_id", "timestamp", "data", "message", "type" ], "properties": { "category": { "type": "string" }, "level": { "type": "string" }, "event_id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "data": { "type": "object", "nullable": true }, "message": { "type": "string", "nullable": true }, "type": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "type": "string" }, "data": { "type": "object", "required": [ "fragment", "cookies", "inferredContentType", "env", "headers", "url", "query", "data", "method" ], "properties": { "fragment": { "type": "string", "nullable": true }, "cookies": { "type": "array", "nullable": true, "items": { "type": "array", "items": { "type": "string" } } }, "inferredContentType": { "type": "string", "nullable": true }, "env": { "type": "object", "nullable": true, "properties": { "ENV": { "type": "string" } } }, "headers": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "url": { "type": "string" }, "query": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "data": { "type": "object", "nullable": true }, "method": { "type": "string", "nullable": true } } } } }, { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "type": "string" }, "data": { "type": "object", "required": [ "formatted" ], "properties": { "formatted": { "type": "string" } } } } }, { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "type": "string" }, "data": { "type": "object", "required": [ "excOmitted", "hasSystemFrames", "values" ], "properties": { "excOmitted": { "type": "array", "nullable": true, "items": { "type": "integer" } }, "hasSystemFrames": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "object", "required": [ "stacktrace", "module", "rawStacktrace", "mechanism", "threadId", "value", "type" ], "properties": { "stacktrace": { "type": "object", "nullable": true, "required": [ "frames", "framesOmitted", "registers", "hasSystemFrames" ], "properties": { "frames": { "type": "array", "items": { "type": "object", "required": [ "function", "errors", "colNo", "vars", "package", "absPath", "inApp", "lineNo", "module", "filename", "platform", "instructionAddr", "context", "symbolAddr", "trust", "symbol" ], "properties": { "function": { "type": "string" }, "errors": { "type": "string", "nullable": true }, "colNo": { "type": "integer", "nullable": true }, "vars": { "type": "object", "nullable": true }, "package": { "type": "string", "nullable": true }, "absPath": { "type": "string", "nullable": true }, "inApp": { "type": "boolean" }, "lineNo": { "type": "integer" }, "module": { "type": "string" }, "filename": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "instructionAddr": { "type": "string", "nullable": true }, "context": { "type": "array", "items": { "type": "array", "items": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] } } }, "symbolAddr": { "type": "string", "nullable": true }, "trust": { "type": "string", "nullable": true }, "symbol": { "type": "string", "nullable": true } } } }, "framesOmitted": { "type": "string", "nullable": true }, "registers": { "type": "string", "nullable": true }, "hasSystemFrames": { "type": "boolean" } } }, "module": { "type": "string", "nullable": true }, "rawStacktrace": { "type": "object", "nullable": true }, "mechanism": { "type": "object", "nullable": true, "properties": { "type": { "type": "string" }, "handled": { "type": "boolean" } } }, "threadId": { "type": "string", "nullable": true }, "value": { "type": "string" }, "type": { "type": "string" } } } } } } } } ] } }, "packages": { "type": "object" }, "sdk": { "type": "object", "properties": { "version": { "type": "string" }, "name": { "type": "string" } } }, "_meta": { "type": "object", "properties": { "user": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "entries": { "type": "object" }, "contexts": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "packages": { "type": "string", "nullable": true }, "tags": { "type": "object" }, "sdk": { "type": "string", "nullable": true } } }, "contexts": { "type": "object", "properties": { "ForbiddenError": { "type": "object", "properties": { "status": { "type": "integer" }, "statusText": { "type": "string" }, "responseJSON": { "type": "object", "properties": { "detail": { "type": "string" } } }, "type": { "type": "string" } } }, "browser": { "type": "object", "properties": { "version": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" } } }, "os": { "type": "object", "properties": { "version": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" } } }, "trace": { "type": "object", "properties": { "span_id": { "type": "string" }, "type": { "type": "string" }, "trace_id": { "type": "string" }, "op": { "type": "string" } } }, "organization": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "slug": { "type": "string" } } } } }, "fingerprints": { "type": "array", "items": { "type": "string" } }, "context": { "type": "object", "properties": { "resp": { "type": "object", "properties": { "status": { "type": "integer" }, "responseJSON": { "type": "object", "properties": { "detail": { "type": "string" } } }, "name": { "type": "string" }, "statusText": { "type": "string" }, "message": { "type": "string" }, "stack": { "type": "string" } } }, "session": { "type": "object", "properties": { "foo": { "type": "string" } } }, "unauthorized": { "type": "boolean" }, "url": { "type": "string" } } }, "groupID": { "type": "string" }, "title": { "type": "string" } } }, "id": { "type": "string" } } } }, "example": [ { "id": "9999aaaaca8b46d797c23c6077c6ff01", "latestEvent": { "eventID": "9999aaaaca8b46d797c23c6077c6ff01", "dist": null, "message": "", "title": "This is an example Python exception", "id": "9999aaafcc8b46d797c23c6077c6ff01", "size": 107762, "errors": [ { "data": { "column": 8, "source": "https://s1.sentry-cdn.com/_static/bloopbloop/sentry/dist/app.js.map", "row": 15 }, "message": "Invalid location in sourcemap", "type": "js_invalid_sourcemap_location" } ], "platform": "javascript", "type": "error", "metadata": { "type": "ForbiddenError", "value": "GET /organizations/hellboy-meowmeow/users/ 403" }, "tags": [ { "value": "Chrome 83.0.4103", "key": "browser", "_meta": null }, { "value": "Chrome", "key": "browser.name", "_meta": null }, { "value": "prod", "key": "environment", "_meta": null }, { "value": "yes", "key": "handled", "_meta": null }, { "value": "error", "key": "level", "_meta": null }, { "value": "generic", "key": "mechanism", "_meta": null } ], "dateCreated": "2020-06-17T22:26:56.098086Z", "dateReceived": "2020-06-17T22:26:56.428721Z", "user": { "username": null, "name": "Hell Boy", "ip_address": "192.168.1.1", "email": "hell@boy.cat", "data": { "isStaff": false }, "id": "550747" }, "entries": [ { "type": "exception", "data": { "values": [ { "stacktrace": { "frames": [ { "function": "ignoreOnError", "errors": null, "colNo": 23, "vars": null, "package": null, "absPath": "webpack:////usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers.js", "inApp": false, "lineNo": 71, "module": "usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers", "filename": "/usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers.js", "platform": null, "instructionAddr": null, "context": [ [ 66, " }" ], [ 67, " // Attempt to invoke user-land function" ], [ 68, " // NOTE: If you are a Sentry user, and you are seeing this stack frame, it" ], [ 69, " // means the sentry.javascript SDK caught an error invoking your application code. This" ], [ 70, " // is expected behavior and NOT indicative of a bug with sentry.javascript." ], [ 71, " return fn.apply(this, wrappedArguments);" ], [ 72, " // tslint:enable:no-unsafe-any" ], [ 73, " }" ], [ 74, " catch (ex) {" ], [ 75, " ignoreNextOnError();" ], [ 76, " withScope(function (scope) {" ] ], "symbolAddr": null, "trust": null, "symbol": null }, { "function": "apply", "errors": null, "colNo": 24, "vars": null, "package": null, "absPath": "webpack:////usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods.js", "inApp": false, "lineNo": 74, "module": "usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods", "filename": "/usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods.js", "platform": null, "instructionAddr": null, "context": [ [ 69, " */" ], [ 70, " triggerAsync: function triggerAsync() {" ], [ 71, " var args = arguments," ], [ 72, " me = this;" ], [ 73, " _.nextTick(function () {" ], [ 74, " me.trigger.apply(me, args);" ], [ 75, " });" ], [ 76, " }," ], [ 77, "" ], [ 78, " /**" ], [ 79, " * Wraps the trigger mechanism with a deferral function." ] ], "symbolAddr": null, "trust": null, "symbol": null } ], "framesOmitted": null, "registers": null, "hasSystemFrames": true }, "module": null, "rawStacktrace": { "frames": [ { "function": "a", "errors": null, "colNo": 88800, "vars": null, "package": null, "absPath": "https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "inApp": false, "lineNo": 81, "module": null, "filename": "/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "platform": null, "instructionAddr": null, "context": [ [ 76, "/*!" ], [ 77, " Copyright (c) 2018 Jed Watson." ], [ 78, " Licensed under the MIT License (MIT), see" ], [ 79, " http://jedwatson.github.io/react-select" ], [ 80, "*/" ], [ 81, "{snip} e,t)}));return e.handleEvent?e.handleEvent.apply(this,s):e.apply(this,s)}catch(e){throw c(),Object(o.m)((function(n){n.addEventProcessor((fu {snip}" ], [ 82, "/*!" ], [ 83, " * JavaScript Cookie v2.2.1" ], [ 84, " * https://github.com/js-cookie/js-cookie" ], [ 85, " *" ], [ 86, " * Copyright 2006, 2015 Klaus Hartl & Fagner Brack" ] ], "symbolAddr": null, "trust": null, "symbol": null }, { "function": null, "errors": null, "colNo": 149484, "vars": null, "package": null, "absPath": "https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "inApp": false, "lineNo": 119, "module": null, "filename": "/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "platform": null, "instructionAddr": null, "context": [ [ 114, "/* @license" ], [ 115, "Papa Parse" ], [ 116, "v5.2.0" ], [ 117, "https://github.com/mholt/PapaParse" ], [ 118, "License: MIT" ], [ 119, "{snip} (){var e=arguments,t=this;r.nextTick((function(){t.trigger.apply(t,e)}))},deferWith:function(e){var t=this.trigger,n=this,r=function(){t.app {snip}" ], [ 120, "/**!" ], [ 121, " * @fileOverview Kickass library to create and place poppers near their reference elements." ], [ 122, " * @version 1.16.1" ], [ 123, " * @license" ], [ 124, " * Copyright (c) 2016 Federico Zivolo and contributors" ] ], "symbolAddr": null, "trust": null, "symbol": null } ], "framesOmitted": null, "registers": null, "hasSystemFrames": true }, "mechanism": { "type": "generic", "handled": true }, "threadId": null, "value": "GET /organizations/hellboy-meowmeow/users/ 403", "type": "ForbiddenError" } ], "excOmitted": null, "hasSystemFrames": true } }, { "type": "breadcrumbs", "data": { "values": [ { "category": "tracing", "level": "debug", "event_id": null, "timestamp": "2020-06-17T22:26:55.266586Z", "data": null, "message": "[Tracing] pushActivity: idleTransactionStarted#1", "type": "debug" }, { "category": "xhr", "level": "info", "event_id": null, "timestamp": "2020-06-17T22:26:55.619446Z", "data": { "url": "/api/0/internal/health/", "status_code": 200, "method": "GET" }, "message": null, "type": "http" }, { "category": "sentry.transaction", "level": "info", "event_id": null, "timestamp": "2020-06-17T22:26:55.945016Z", "data": null, "message": "7787a027f3fb46c985aaa2287b3f4d09", "type": "default" } ] } }, { "type": "request", "data": { "fragment": null, "cookies": [], "inferredContentType": null, "env": null, "headers": [ [ "User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.97 Safari/537.36" ] ], "url": "https://sentry.io/organizations/hellboy-meowmeow/issues/", "query": [ [ "project", "5236886" ] ], "data": null, "method": null } } ], "packages": {}, "sdk": { "version": "5.17.0", "name": "sentry.javascript.browser" }, "_meta": { "user": null, "context": null, "entries": {}, "contexts": null, "message": null, "packages": null, "tags": {}, "sdk": null }, "contexts": { "ForbiddenError": { "status": 403, "statusText": "Forbidden", "responseJSON": { "detail": "You do not have permission to perform this action." }, "type": "default" }, "browser": { "version": "83.0.4103", "type": "browser", "name": "Chrome" }, "os": { "version": "10", "type": "os", "name": "Windows" }, "trace": { "span_id": "83db1ad17e67dfe7", "type": "trace", "trace_id": "da6caabcd90e45fdb81f6655824a5f88", "op": "navigation" }, "organization": { "type": "default", "id": "323938", "slug": "hellboy-meowmeow" } }, "fingerprints": [ "fbe908cc63d63ea9763fd84cb6bad177" ], "context": { "resp": { "status": 403, "responseJSON": { "detail": "You do not have permission to perform this action." }, "name": "ForbiddenError", "statusText": "Forbidden", "message": "GET /organizations/hellboy-meowmeow/users/ 403", "stack": "Error\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480441\n at u (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:51006)\n at Generator._invoke (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:50794)\n at Generator.A.forEach.e. [as next] (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:51429)\n at n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68684)\n at s (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68895)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68954\n at new Promise ()\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68835\n at v (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480924)\n at m (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480152)\n at t.fetchMemberList (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:902983)\n at t.componentDidMount (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:900527)\n at t.componentDidMount (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:15597)\n at Pc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:101023)\n at t.unstable_runWithPriority (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:3462)\n at Ko (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45529)\n at Rc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:97371)\n at Oc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:87690)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45820\n at t.unstable_runWithPriority (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:3462)\n at Ko (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45529)\n at Zo (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45765)\n at Jo (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45700)\n at gc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:84256)\n at Object.enqueueSetState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:50481)\n at t.M.setState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:173:1439)\n at t.onUpdate (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:543076)\n at a.n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149090)\n at a.emit (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:6550)\n at p.trigger (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149379)\n at p.onInitializeUrlState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:541711)\n at a.n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149090)\n at a.emit (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:6550)\n at Function.trigger (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149379)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149484\n at a (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:81:88800)" } }, "groupID": "1341191803" } } ] } } }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "event:read" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/": { "get": { "tags": [ "Events" ], "description": "Return details on an individual issue. This returns the basic stats for the issue (title, last seen, first seen), some overall numbers (number of comments, user reports) as well as the summarized event data.", "operationId": "Retrieve an Issue", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the issue belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "issue_id", "in": "path", "description": "The ID of the issue to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "collapse", "in": "query", "description": "Fields to remove from the response to improve query performance.", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "stats", "lifetime", "base", "unhandled", "filtered" ] } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "activity", "annotations", "assignedTo", "count", "culprit", "firstRelease", "firstSeen", "hasSeen", "id", "isBookmarked", "isPublic", "isSubscribed", "lastRelease", "lastSeen", "level", "logger", "metadata", "numComments", "participants", "permalink", "pluginActions", "pluginContexts", "pluginIssues", "project", "seenBy", "shareId", "shortId", "stats", "status", "statusDetails", "subscriptionDetails", "tags", "title", "type", "userCount", "userReportCount" ], "properties": { "activity": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object" }, "dateCreated": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "object", "nullable": true } } } }, "annotations": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string" }, "url": { "type": "string" } } } }, "assignedTo": { "type": "object", "nullable": true }, "count": { "type": "string" }, "culprit": { "type": "string" }, "firstRelease": { "type": "object", "nullable": true, "properties": { "authors": { "type": "array", "items": { "type": "string" } }, "commitCount": { "type": "integer" }, "data": { "type": "object", "nullable": true }, "dateCreated": { "type": "string" }, "dateReleased": { "type": "string", "nullable": true }, "deployCount": { "type": "integer" }, "firstEvent": { "type": "string" }, "lastCommit": { "type": "string", "nullable": true }, "lastDeploy": { "type": "string", "nullable": true }, "lastEvent": { "type": "string" }, "newGroups": { "type": "integer" }, "owner": { "type": "string", "nullable": true }, "projects": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } } } }, "ref": { "type": "string", "nullable": true }, "shortVersion": { "type": "string" }, "url": { "type": "string", "nullable": true }, "version": { "type": "string" } } }, "firstSeen": { "type": "string" }, "hasSeen": { "type": "boolean" }, "id": { "type": "string" }, "isBookmarked": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "lastRelease": { "type": "object", "nullable": true }, "lastSeen": { "type": "string" }, "level": { "type": "string" }, "logger": { "type": "string", "nullable": true }, "metadata": { "oneOf": [ { "type": "object", "required": [ "filename", "type", "value" ], "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } } }, { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string" } } } ] }, "numComments": { "type": "integer" }, "participants": { "type": "array", "items": { "type": "object" } }, "permalink": { "type": "string" }, "pluginActions": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "pluginContexts": { "type": "array", "items": { "type": "string" } }, "pluginIssues": { "type": "array", "items": { "type": "object" } }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "seenBy": { "type": "array", "items": { "type": "object" } }, "shareId": { "type": "string", "nullable": true }, "shortId": { "type": "string" }, "stats": { "type": "object", "properties": { "24h": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "30d": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } } } }, "status": { "type": "string", "enum": [ "resolved", "unresolved", "ignored" ] }, "statusDetails": { "type": "object" }, "subscriptionDetails": { "type": "object", "nullable": true }, "tags": { "type": "array", "items": { "type": "object" } }, "title": { "type": "string" }, "type": { "type": "string" }, "userCount": { "type": "integer" }, "userReportCount": { "type": "integer" } } }, "example": { "activity": [ { "data": {}, "dateCreated": "2018-11-06T21:19:55Z", "id": "0", "type": "first_seen", "user": null } ], "annotations": [], "assignedTo": null, "count": "1", "culprit": "raven.scripts.runner in main", "firstRelease": { "authors": [], "commitCount": 0, "data": {}, "dateCreated": "2018-11-06T21:19:55.146Z", "dateReleased": null, "deployCount": 0, "firstEvent": "2018-11-06T21:19:55.271Z", "lastCommit": null, "lastDeploy": null, "lastEvent": "2018-11-06T21:19:55.271Z", "newGroups": 0, "owner": null, "projects": [ { "name": "Pump Station", "slug": "pump-station" } ], "ref": null, "shortVersion": "1764232", "url": null, "version": "17642328ead24b51867165985996d04b29310337" }, "firstSeen": "2018-11-06T21:19:55Z", "hasSeen": false, "id": "1", "isBookmarked": false, "isPublic": false, "isSubscribed": true, "lastRelease": null, "lastSeen": "2018-11-06T21:19:55Z", "level": "error", "logger": null, "metadata": { "title": "This is an example Python exception" }, "numComments": 0, "participants": [], "permalink": "https://sentry.io/the-interstellar-jurisdiction/pump-station/issues/1/", "pluginActions": [], "pluginContexts": [], "pluginIssues": [], "project": { "id": "2", "name": "Pump Station", "slug": "pump-station" }, "seenBy": [], "shareId": null, "shortId": "PUMP-STATION-1", "stats": { "24h": [ [ 1541451600, 557 ], [ 1541455200, 473 ], [ 1541458800, 914 ], [ 1541462400, 991 ], [ 1541466000, 925 ], [ 1541469600, 881 ], [ 1541473200, 182 ], [ 1541476800, 490 ], [ 1541480400, 820 ], [ 1541484000, 322 ], [ 1541487600, 836 ], [ 1541491200, 565 ], [ 1541494800, 758 ], [ 1541498400, 880 ], [ 1541502000, 677 ], [ 1541505600, 381 ], [ 1541509200, 814 ], [ 1541512800, 329 ], [ 1541516400, 446 ], [ 1541520000, 731 ], [ 1541523600, 111 ], [ 1541527200, 926 ], [ 1541530800, 772 ], [ 1541534400, 400 ], [ 1541538000, 943 ] ], "30d": [ [ 1538870400, 565 ], [ 1538956800, 12862 ], [ 1539043200, 15617 ], [ 1539129600, 10809 ], [ 1539216000, 15065 ], [ 1539302400, 12927 ], [ 1539388800, 12994 ], [ 1539475200, 13139 ], [ 1539561600, 11838 ], [ 1539648000, 12088 ], [ 1539734400, 12338 ], [ 1539820800, 12768 ], [ 1539907200, 12816 ], [ 1539993600, 15356 ], [ 1540080000, 10910 ], [ 1540166400, 12306 ], [ 1540252800, 12912 ], [ 1540339200, 14700 ], [ 1540425600, 11890 ], [ 1540512000, 11684 ], [ 1540598400, 13510 ], [ 1540684800, 12625 ], [ 1540771200, 12811 ], [ 1540857600, 13180 ], [ 1540944000, 14651 ], [ 1541030400, 14161 ], [ 1541116800, 12612 ], [ 1541203200, 14316 ], [ 1541289600, 14742 ], [ 1541376000, 12505 ], [ 1541462400, 14180 ] ] }, "status": "unresolved", "statusDetails": {}, "subscriptionDetails": null, "tags": [], "title": "This is an example Python exception", "type": "default", "userCount": 0, "userReportCount": 0 } } } }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "event:read" ] } ] }, "put": { "tags": [ "Events" ], "description": "Updates an individual issue's attributes. Only the attributes submitted are modified.", "operationId": "Update an Issue", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the issue belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "issue_id", "in": "path", "description": "The ID of the group to retrieve.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "The new status for the issues. Valid values are `\"resolved\"`, `\"resolvedInNextRelease\"`, `\"unresolved\"`, and `\"ignored\"`." }, "statusDetails": { "type": "object", "description": "Additional details about the resolution. Supported values are `\"inRelease\"`, `\"inNextRelease\"`, `\"inCommit\"`, `\"ignoreDuration\"`, `\"ignoreCount\"`, `\"ignoreWindow\"`, `\"ignoreUserCount\"`, and `\"ignoreUserWindow\"`.", "properties": { "inNextRelease": { "type": "boolean", "description": "Indicates if the issue is resolved in the next release based on the last seen release of that issue." }, "inRelease": { "type": "string", "description": "The version of the release in which the issue is resolved." }, "inCommit": { "type": "string", "description": "The commit hash in which the issue is resolved." } } }, "assignedTo": { "type": "string", "description": "The actor id (or username) of the user or team that should be assigned to this issue." }, "hasSeen": { "type": "boolean", "description": "In case this API call is invoked with a user context this allows changing of the flag that indicates if the user has seen the event." }, "isBookmarked": { "type": "boolean", "description": "In case this API call is invoked with a user context this allows changing of the bookmark flag." }, "isSubscribed": { "type": "boolean", "description": "In case this API call is invoked with a user context this allows the user to subscribe to workflow notications for this issue." }, "isPublic": { "type": "boolean", "description": "Sets the issue to public or private." } } }, "example": { "status": "unresolved" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "lastSeen", "numComments", "userCount", "culprit", "title", "id", "assignedTo", "logger", "type", "annotations", "metadata", "status", "subscriptionDetails", "isPublic", "hasSeen", "shortId", "shareId", "firstSeen", "count", "permalink", "level", "isSubscribed", "isBookmarked", "project", "statusDetails" ], "properties": { "annotations": { "type": "array", "items": { "type": "string" } }, "assignedTo": { "type": "object", "nullable": true }, "count": { "type": "string" }, "culprit": { "type": "string" }, "firstSeen": { "type": "string" }, "hasSeen": { "type": "boolean" }, "id": { "type": "string" }, "isBookmarked": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "lastSeen": { "type": "string" }, "level": { "type": "string" }, "logger": { "type": "string", "nullable": true }, "metadata": { "oneOf": [ { "type": "object", "required": [ "filename", "type", "value" ], "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } } }, { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string" } } } ] }, "numComments": { "type": "integer" }, "permalink": { "type": "string" }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "shareId": { "type": "string", "nullable": true }, "shortId": { "type": "string" }, "status": { "type": "string", "enum": [ "resolved", "unresolved", "ignored" ] }, "statusDetails": { "type": "object" }, "subscriptionDetails": { "type": "object", "nullable": true }, "title": { "type": "string" }, "type": { "type": "string" }, "userCount": { "type": "integer" } } }, "example": { "annotations": [], "assignedTo": null, "count": "1", "culprit": "raven.scripts.runner in main", "firstSeen": "2018-11-06T21:19:55Z", "hasSeen": false, "id": "1", "isBookmarked": false, "isPublic": false, "isSubscribed": true, "lastSeen": "2018-11-06T21:19:55Z", "level": "error", "logger": null, "metadata": { "title": "This is an example Python exception" }, "numComments": 0, "permalink": "https://sentry.io/the-interstellar-jurisdiction/pump-station/issues/1/", "project": { "id": "2", "name": "Pump Station", "slug": "pump-station" }, "shareId": null, "shortId": "PUMP-STATION-1", "status": "unresolved", "statusDetails": {}, "subscriptionDetails": null, "title": "This is an example Python exception", "type": "default", "userCount": 0 } } } }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "event:write" ] } ] }, "delete": { "tags": [ "Events" ], "description": "Removes an individual issue.", "operationId": "Remove an Issue", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the issue belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "issue_id", "in": "path", "description": "The ID of the issue to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "The requested resource does not exist" } }, "security": [ { "auth_token": [ "event:admin" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/releases/": { "get": { "tags": [ "Releases" ], "description": "Return a list of releases for a given organization.", "operationId": "List an Organization's Releases", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "This parameter can be used to create a \"starts with\" filter for the version.", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "authors", "commitCount", "data", "dateCreated", "dateReleased", "deployCount", "firstEvent", "lastCommit", "lastDeploy", "lastEvent", "newGroups", "owner", "projects", "ref", "shortVersion", "version", "url" ], "properties": { "id": { "type": "integer" }, "authors": { "type": "array", "items": { "type": "object" } }, "commitCount": { "type": "integer", "format": "int64" }, "data": { "type": "object" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "deployCount": { "type": "integer", "format": "int64" }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "lastCommit": { "type": "object", "nullable": true }, "lastDeploy": { "type": "object", "nullable": true, "oneOf": [ { "type": "object", "required": [ "environment", "name", "dateStarted", "dateFinished", "url", "id" ], "properties": { "environment": { "type": "string" }, "name": { "type": "string", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "dateFinished": { "type": "string", "format": "date-time" }, "url": { "type": "string", "nullable": true }, "id": { "type": "string" } } }, { "type": "string", "nullable": true, "not": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object" }, { "type": "array", "items": {} } ] } } ] }, "lastEvent": { "type": "string", "format": "date-time", "nullable": true }, "newGroups": { "type": "integer", "format": "int64" }, "owner": { "type": "object", "nullable": true }, "projects": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } } } }, "ref": { "type": "string", "nullable": true }, "shortVersion": { "type": "string" }, "version": { "type": "string" }, "url": { "type": "string", "nullable": true } } } }, "example": [ { "id": 2, "authors": [], "commitCount": 0, "data": {}, "dateCreated": "2018-11-06T21:20:08.033Z", "dateReleased": null, "deployCount": 0, "firstEvent": null, "lastCommit": null, "lastDeploy": null, "lastEvent": null, "newGroups": 0, "owner": null, "projects": [ { "name": "Pump Station", "slug": "pump-station" } ], "ref": "6ba09a7c53235ee8a8fa5ee4c1ca8ca886e7fdbb", "shortVersion": "2.0rc2", "url": null, "version": "2.0rc2" }, { "id": 1, "authors": [], "commitCount": 0, "data": {}, "dateCreated": "2018-11-06T21:19:58.559Z", "dateReleased": null, "deployCount": 0, "firstEvent": "2018-11-06T21:19:58.639Z", "lastCommit": null, "lastDeploy": null, "lastEvent": "2018-11-06T21:19:58.639Z", "newGroups": 0, "owner": null, "projects": [ { "name": "Prime Mover", "slug": "prime-mover" } ], "ref": null, "shortVersion": "2b6af31", "url": null, "version": "2b6af31b2edccc73a629108b17344dfe20858780" } ] } } }, "401": { "description": "Permission Denied" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] }, "post": { "tags": [ "Releases" ], "description": "Create a new release for the given organization. Releases are used by\nSentry to improve its error reporting abilities by correlating\nfirst seen events with the release that might have introduced the\nproblem.\nReleases are also necessary for source maps and other debug features\nthat require manual upload for functioning well.", "operationId": "Create a New Release for an Organization", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "version", "projects" ], "properties": { "version": { "type": "string", "description": "A version identifier for this release. Can be a version number, a commit hash, etc." }, "projects": { "type": "array", "description": "A list of project slugs that are involved in this release.", "items": { "type": "string" } }, "ref": { "type": "string", "description": "An optional commit reference. This is useful if a tagged version has been provided." }, "url": { "type": "string", "description": "A URL that points to the release. This can be the path to an online interface to the source code for instance" }, "dateReleased": { "type": "string", "format": "date-time", "description": "An optional date that indicates when the release went live. If not provided the current time is assumed." }, "commits": { "type": "array", "items": { "type": "object", "properties": { "patch_set": { "type": "array", "description": "A list of the files that have been changed in the commit. Specifying the patch_set is necessary to power suspect commits and suggested assignees.", "items": { "type": "object", "required": [ "path", "type" ], "properties": { "path": { "type": "string", "description": "The path to the file. Both forward and backward slashes are supported." }, "type": { "type": "string", "enum": [ "A", "M", "D" ], "description": "The type of change that happened in the commit." } } } }, "repository": { "type": "string", "description": "The full name of the repository the commit belongs to. If this field is not given Sentry will generate a name in the form: u'organization-' (i.e. if the organization id is 123, then the generated repository name will be u'organization-123)." }, "author_name": { "type": "string", "description": "The name of the commit author." }, "author_email": { "type": "string", "description": "The email of the commit author. The commit author's email is required to enable the suggested assignee feature." }, "timestamp": { "type": "string", "format": "date-time", "description": "The commit timestamp is used to sort the commits given. If a timestamp is not included, the commits will remain sorted in the order given." }, "message": { "type": "string", "description": "The commit message." }, "id": { "type": "string", "description": "The commit ID (the commit SHA)." } } }, "description": "An optional list of commit data to be associated with the release. Commits must include parameters `id` (the SHA of the commit), and can optionally include `repository`, `message`, `patch_set`, `author_name`, `author_email`, and `timestamp`." }, "refs": { "type": "array", "items": { "type": "object", "properties": { "repository": { "type": "string", "description": "The full name of the repository the commit belongs to." }, "commit": { "type": "string", "description": "The current release's commit." }, "previousCommit": { "type": "string", "description": "The previous release's commit." } } }, "description": "An optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters `repository` and `commit` (the HEAD sha). They can optionally include `previousCommit` (the sha of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data. `commit` may contain a range in the form of `previousCommit..commit`." } } }, "example": { "version": "2.0rc2", "ref": "6ba09a7c53235ee8a8fa5ee4c1ca8ca886e7fdbb", "projects": [ "pump-station" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "authors", "commitCount", "data", "dateCreated", "dateReleased", "deployCount", "firstEvent", "lastCommit", "lastDeploy", "lastEvent", "newGroups", "owner", "projects", "ref", "shortVersion", "version", "url" ], "properties": { "id": { "type": "integer" }, "authors": { "type": "array", "items": { "type": "object" } }, "commitCount": { "type": "integer", "format": "int64" }, "data": { "type": "object" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "deployCount": { "type": "integer", "format": "int64" }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "lastCommit": { "type": "object", "nullable": true }, "lastDeploy": { "type": "object", "nullable": true, "oneOf": [ { "type": "object", "required": [ "environment", "name", "dateStarted", "dateFinished", "url", "id" ], "properties": { "environment": { "type": "string" }, "name": { "type": "string", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "dateFinished": { "type": "string", "format": "date-time" }, "url": { "type": "string", "nullable": true }, "id": { "type": "string" } } }, { "type": "string", "nullable": true, "not": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object" }, { "type": "array", "items": {} } ] } } ] }, "lastEvent": { "type": "string", "format": "date-time", "nullable": true }, "newGroups": { "type": "integer", "format": "int64" }, "owner": { "type": "object", "nullable": true }, "projects": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } } } }, "ref": { "type": "string", "nullable": true }, "shortVersion": { "type": "string" }, "version": { "type": "string" }, "url": { "type": "string", "nullable": true } } }, "example": { "id": 2, "authors": [], "commitCount": 0, "data": {}, "dateCreated": "2019-01-03T00:12:55.109Z", "dateReleased": null, "deployCount": 0, "firstEvent": null, "lastCommit": null, "lastDeploy": null, "lastEvent": null, "newGroups": 0, "owner": null, "projects": [ { "name": "Pump Station", "slug": "pump-station" } ], "ref": "6ba09a7c53235ee8a8fa5ee4c1ca8ca886e7fdbb", "shortVersion": "2.0rc2", "url": null, "version": "2.0rc2" } } } }, "400": { "description": "Bad Input" }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "project:releases" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/releases/{version}/files/": { "get": { "tags": [ "Releases" ], "description": "Return a list of files for a given release.", "operationId": "List an Organization's Release Files", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "sha1", "dist", "name", "dateCreated", "headers", "id", "size" ], "properties": { "sha1": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } }, "id": { "type": "string" }, "size": { "type": "integer" } } } }, "example": [ { "dateCreated": "2018-11-06T21:20:22.894Z", "dist": null, "headers": { "Content-Type": "text/plain; encoding=utf-8" }, "id": "3", "name": "/demo/goodbye.txt", "sha1": "94d6b21e962a9fc65889617ec1f17a1e2fe11b65", "size": 15 } ] } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] }, "post": { "tags": [ "Releases" ], "description": "Upload a new file for the given release.\n\nUnlike other API requests, files must be uploaded using the traditional multipart/form-data content-type.\n\nRequests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io`.\n\nThe optional 'name' attribute should reflect the absolute path that this file will be referenced as. For example, in the case of JavaScript you might specify the full web URI.", "operationId": "Upload a New Organization Release File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "The multipart encoded file." }, "name": { "type": "string", "description": "The name (full path) of the file." }, "dist": { "type": "string", "description": "The name of the dist." }, "header": { "type": "string", "description": "This parameter can be supplied multiple times to attach headers to the file. Each header is a string in the format `key:value`. For instance it can be used to define a content type." } } }, "example": { "name": "/demo/release.min.js", "file": "release.min.js" } } } }, "responses": { "201": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ], "servers": [ { "url": "https://{region}.sentry.io" } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/files/": { "get": { "tags": [ "Releases" ], "description": "Return a list of files for a given release.", "operationId": "List a Project's Release Files", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "sha1", "dist", "name", "dateCreated", "headers", "id", "size" ], "properties": { "sha1": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } }, "id": { "type": "string" }, "size": { "type": "integer" } } } }, "example": [ { "dateCreated": "2018-11-06T21:20:22.894Z", "dist": null, "headers": { "Content-Type": "text/plain; encoding=utf-8" }, "id": "3", "name": "/demo/goodbye.txt", "sha1": "94d6b21e962a9fc65889617ec1f17a1e2fe11b65", "size": 15 } ] } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] }, "post": { "tags": [ "Releases" ], "description": "Upload a new file for the given release.\n\nUnlike other API requests, files must be uploaded using the traditional multipart/form-data content-type.\n\nRequests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io`\n\nThe optional 'name' attribute should reflect the absolute path that this file will be referenced as. For example, in the case of JavaScript you might specify the full web URI.", "operationId": "Upload a New Project Release File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "The multipart encoded file." }, "name": { "type": "string", "description": "The name (full path) of the file." }, "dist": { "type": "string", "description": "The name of the dist." }, "header": { "type": "string", "description": "This parameter can be supplied multiple times to attach headers to the file. Each header is a string in the format `key:value`. For instance it can be used to define a content type." } } }, "example": { "name": "/demo/hello.min.js.map", "file": "@hello.min.js.map" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "sha1", "dist", "name", "dateCreated", "headers", "id", "size" ], "properties": { "sha1": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } }, "id": { "type": "string" }, "size": { "type": "integer" } } }, "example": { "dateCreated": "2018-11-06T21:20:22.894Z", "dist": null, "headers": { "Content-Type": "text/plain; encoding=utf-8" }, "id": "3", "name": "/demo/goodbye.txt", "sha1": "94d6b21e962a9fc65889617ec1f17a1e2fe11b65", "size": 15 } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ], "servers": [ { "url": "https://{region}.sentry.io" } ] } }, "/api/0/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/": { "get": { "tags": [ "Releases" ], "description": "Retrieve a file for a given release.", "operationId": "Retrieve an Organization Release's File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "file_id", "in": "path", "description": "The ID of the file to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "download", "in": "query", "description": "If this is set to true, then the response payload will be the raw file contents. Otherwise, the response will be the file metadata as JSON.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "sha1", "dist", "name", "dateCreated", "headers", "id", "size" ], "properties": { "sha1": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } }, "id": { "type": "string" }, "size": { "type": "integer" } } }, "example": { "dateCreated": "2018-11-06T21:20:19.150Z", "dist": null, "headers": { "Content-Type": "text/plain; encoding=utf-8" }, "id": "1", "name": "/demo/message-for-you.txt", "sha1": "2ef7bde608ce5404e97d5f042f95f89f1c232871", "size": 12 } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] }, "put": { "tags": [ "Releases" ], "description": "Update an organization release file.", "operationId": "Update an Organization Release File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "file_id", "in": "path", "description": "The ID of the file to retrieve.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The new name (full path) of the file." }, "dist": { "type": "string", "description": "The new name of the dist." } } }, "example": { "name": "/demo/goodbye.txt" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "sha1", "dist", "name", "dateCreated", "headers", "id", "size" ], "properties": { "sha1": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } }, "id": { "type": "string" }, "size": { "type": "integer" } } }, "example": { "dateCreated": "2018-11-06T21:20:22.894Z", "dist": null, "headers": { "Content-Type": "text/plain; encoding=utf-8" }, "id": "3", "name": "/demo/goodbye.txt", "sha1": "94d6b21e962a9fc65889617ec1f17a1e2fe11b65", "size": 15 } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] }, "delete": { "tags": [ "Releases" ], "description": "Delete a file for a given release.", "operationId": "Delete an Organization Release's File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the release belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "file_id", "in": "path", "description": "The ID of the file to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/files/{file_id}/": { "get": { "tags": [ "Releases" ], "description": "Retrieve a file for a given release.", "operationId": "Retrieve a Project Release's File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "file_id", "in": "path", "required": true, "description": "The ID of the file to retrieve.", "schema": { "type": "string" } }, { "name": "download", "in": "query", "description": "If this is set to true, then the response payload will be the raw file contents. Otherwise, the response will be the file metadata as JSON.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "sha1", "dist", "name", "dateCreated", "headers", "id", "size" ], "properties": { "sha1": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } }, "id": { "type": "string" }, "size": { "type": "integer" } } }, "example": { "dateCreated": "2018-11-06T21:20:19.150Z", "dist": null, "headers": { "Content-Type": "text/plain; encoding=utf-8" }, "id": "1", "name": "/demo/message-for-you.txt", "sha1": "2ef7bde608ce5404e97d5f042f95f89f1c232871", "size": 12 } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] }, "put": { "tags": [ "Releases" ], "description": "Update a project release file.", "operationId": "Update a Project Release File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "file_id", "in": "path", "description": "The ID of the file to retrieve.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The new name (full path) of the file." }, "dist": { "type": "string", "description": "The new name of the dist." } } }, "example": { "name": "/demo/goodbye.txt" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "sha1", "dist", "name", "dateCreated", "headers", "id", "size" ], "properties": { "sha1": { "type": "string" }, "dist": { "type": "string", "nullable": true }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } } }, "id": { "type": "string" }, "size": { "type": "integer" } } }, "example": { "dateCreated": "2018-11-06T21:20:22.894Z", "dist": null, "headers": { "Content-Type": "text/plain; encoding=utf-8" }, "id": "3", "name": "/demo/goodbye.txt", "sha1": "94d6b21e962a9fc65889617ec1f17a1e2fe11b65", "size": 15 } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] }, "delete": { "tags": [ "Releases" ], "description": "Delete a file for a given release.", "operationId": "Delete a Project Release's File", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the release belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "file_id", "in": "path", "description": "The ID of the file to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/releases/{version}/commits/": { "get": { "tags": [ "Releases" ], "description": "List an organization release's commits.", "operationId": "List an Organization Release's Commits", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the release belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "dateCreated", "id", "message" ], "properties": { "dateCreated": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "message": { "type": "string", "nullable": true } } } }, "example": [ { "dateCreated": "2018-11-06T21:19:58.536Z", "id": "acbafc639127fd89d10f474520104517ff1d709e", "message": "Initial commit from Create Next App" } ] } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] } }, "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/commits/": { "get": { "tags": [ "Releases" ], "description": "List a project release's commits.", "operationId": "List a Project Release's Commits", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the release belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "project_id_or_slug", "in": "path", "description": "The ID or slug of the project the release belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "dateCreated", "id", "message" ], "properties": { "dateCreated": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "message": { "type": "string", "nullable": true } } } }, "example": [ { "dateCreated": "2018-11-06T21:19:58.536Z", "id": "acbafc639127fd89d10f474520104517ff1d709e", "message": "Initial commit from Create Next App" } ] } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/releases/{version}/commitfiles/": { "get": { "tags": [ "Releases" ], "description": "Retrieve files changed in a release's commits", "operationId": "Retrieve Files Changed in a Release's Commits", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the release belongs to.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version identifier of the release.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "project:releases" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/sentry-app-installations/": { "get": { "tags": [ "Integration" ], "description": "Return a list of integration platform installations for a given organization.", "operationId": "List an Organization's Integration Platform Installations", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The organization short name.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.", "x-learn-more": "https://docs.sentry.io/api/pagination/", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "app", "organization", "uuid", "status" ], "properties": { "app": { "type": "object", "required": [ "uuid", "slug", "sentryAppId" ], "properties": { "uuid": { "type": "string" }, "slug": { "type": "string" }, "sentryAppId": { "type": "integer" } } }, "organization": { "type": "object", "required": [ "slug" ], "properties": { "slug": { "type": "string" } } }, "uuid": { "type": "string" }, "status": { "type": "string" } } } }, "example": [ { "app": { "uuid": "a9988ad6-meow-4905-bb93-f7cbf4c96bbb", "slug": "cat-75c19a", "sentryAppId": 1 }, "organization": { "slug": "sentry" }, "uuid": "01635075-m30w-4f96-8fc8-ff9680780a13", "status": "installed" } ] } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "org:read", "org:integrations" ] } ] } }, "/api/0/sentry-app-installations/{uuid}/external-issues/": { "post": { "tags": [ "Integration" ], "description": "Create or update an external issue from an integration platform integration.", "operationId": "Create or update an External Issue", "parameters": [ { "name": "uuid", "in": "path", "description": "The uuid of the integration platform integration.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "issueId", "webUrl", "project", "identifier" ], "type": "object", "properties": { "issueId": { "type": "integer", "description": "The ID of the Sentry issue to link the external issue to." }, "webUrl": { "type": "string", "description": "The URL of the external service to link the issue to." }, "project": { "type": "string", "description": "The external service's project." }, "identifier": { "type": "string", "description": "A unique identifier of the external issue." } } }, "example": { "issueId": 1, "webUrl": "https://somerandom.io/project/issue-id", "project": "ExternalProj", "identifier": "issue-1" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "issueId", "serviceType", "displayName", "webUrl" ], "properties": { "id": { "type": "string" }, "issueId": { "type": "string" }, "serviceType": { "type": "string" }, "displayName": { "type": "string" }, "webUrl": { "type": "string" } } }, "example": { "id": "1", "issueId": "1", "serviceType": "testing", "displayName": "ExternalProj#issue-1", "webUrl": "https://somerandom.io/project/issue-id" } } } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "security": [ { "auth_token": [ "event:write" ] } ] } }, "/api/0/sentry-app-installations/{uuid}/external-issues/{external_issue_id}/": { "delete": { "tags": [ "Integration" ], "description": "Delete an external issue.", "operationId": "Delete an External Issue", "parameters": [ { "name": "uuid", "in": "path", "description": "The uuid of the integration platform integration.", "required": true, "schema": { "type": "string" } }, { "name": "external_issue_id", "in": "path", "description": "The ID of the external issue.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "403": { "description": "Forbidden" }, "404": { "description": "External issue not found" } }, "security": [ { "auth_token": [ "event:admin" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/spike-protections/": { "post": { "tags": [ "Projects" ], "description": "Enables Spike Protection feature for some of the projects within the organization.", "operationId": "Enable Spike Protection", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the projects belong to", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Django Rest Framework serializer for incoming Spike Protection API payloads", "properties": { "projects": { "description": "Slugs of projects to enable Spike Protection for. Set to `$all` to enable Spike Protection for all the projects in the organization.", "type": "array", "items": { "type": "string" } } }, "required": [ "projects" ] } } }, "required": true }, "responses": { "201": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "project:read", "project:write", "project:admin" ] } ] }, "delete": { "tags": [ "Projects" ], "description": "Disables Spike Protection feature for some of the projects within the organization.", "operationId": "Disable Spike Protection", "parameters": [ { "name": "organization_id_or_slug", "in": "path", "description": "The ID or slug of the organization the projects belong to", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Django Rest Framework serializer for incoming Spike Protection API payloads", "properties": { "projects": { "description": "Slugs of projects to disable Spike Protection for. Set to `$all` to disable Spike Protection for all the projects in the organization.", "type": "array", "items": { "type": "string" } } }, "required": [ "projects" ] } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } }, "security": [ { "auth_token": [ "project:read", "project:write", "project:admin" ] } ] } }, "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/autofix/": { "get": { "operationId": "Retrieve Seer Issue Fix State", "description": "Retrieve the current detailed state of an issue fix process for a specific issue including:\n\n- Current status\n- Steps performed and their outcomes\n- Repository information and permissions\n- Root Cause Analysis\n- Proposed Solution\n- Generated code changes\n\nThis endpoint although documented is still experimental and the payload may change in the future.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "issue_id", "schema": { "type": "integer" }, "description": "The ID of the issue you'd like to query.", "required": true } ], "tags": [ "Seer" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "Response type for the GET endpoint", "properties": { "autofix": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "autofix" ] }, "examples": { "AutofixInProgress": { "value": { "autofix": { "run_id": 12345, "request": { "organization_id": 1, "project_id": 2, "repos": [ { "integration_id": "12345", "provider": "github", "owner": "getsentry", "name": "seer", "external_id": "439438299", "branch_name": "main", "base_commit_sha": "4ebb4f342e308fda87d6ccb3cced25f2701bd60c" } ], "tags_overview": { "tags_overview": [ { "key": "environment", "name": "Environment", "top_values": [ { "count": 1, "percentage": "100%", "value": "production" } ] }, { "key": "run_id", "name": "Run Id", "top_values": [ { "count": 1, "percentage": "100%", "value": "1372444" } ] } ] }, "options": { "auto_run_source": "issue_summary_on_alert_fixability" } }, "updated_at": "2025-09-23T21:02:18.160885", "status": "COMPLETED", "codebases": { "439438299": { "repo_external_id": "439438299", "file_changes": [], "is_readable": true, "is_writeable": true } }, "steps": [ { "active_comment_thread": null, "agent_comment_thread": null, "completedMessage": null, "id": "0872381c-7d71-46cd-a62b-fbc196846965", "index": 0, "initial_memory_length": 1, "insights": [], "key": "root_cause_analysis_processing", "output_confidence_score": null, "output_stream": null, "proceed_confidence_score": null, "progress": [ { "data": null, "message": "Figuring out the root cause...", "timestamp": "2025-09-12T23:20:31.304114", "type": "INFO" }, { "data": null, "message": "Looking at `src/seer/automation/autofix/tools/tools.py` in `getsentry/seer`...", "timestamp": "2025-09-12T23:20:49.671212", "type": "INFO" }, { "data": null, "message": "Simulating profound thought...", "timestamp": "2025-09-12T23:20:58.229135", "type": "INFO" }, { "data": null, "message": "Arranging data in a way that looks intentional...", "timestamp": "2025-09-12T23:21:22.696531", "type": "INFO" } ], "queued_user_messages": [], "status": "COMPLETED", "title": "Analyzing the Issue", "type": "default" }, { "active_comment_thread": null, "agent_comment_thread": null, "causes": [ { "description": "`BaseTools.run_ripgrep` called without required `query` argument, causing `TypeError`.", "id": 0, "relevant_repos": [ "getsentry/seer" ], "reproduction_urls": [], "root_cause_reproduction": [ { "code_snippet_and_analysis": "The process begins with an HTTP request to the `autofix_start_endpoint`. This is the entry point for the autofix workflow.", "is_most_important_event": false, "relevant_code_file": { "file_path": "seer/app.py", "repo_name": "getsentry/seer" }, "timeline_item_type": "internal_code", "title": "Autofix process initiated via API endpoint." } ] } ], "completedMessage": null, "id": "e6ae64b6-e4d4-44f5-bac7-6ecf6780a6dc", "index": 1, "key": "root_cause_analysis", "output_stream": null, "progress": [ { "data": null, "message": "Here is Autofix's proposed root cause.", "timestamp": "2025-09-12T23:21:30.662818", "type": "INFO" } ], "queued_user_messages": [], "selection": { "cause_id": 0, "instruction": null }, "status": "COMPLETED", "termination_reason": null, "title": "Root Cause Analysis", "type": "root_cause_analysis" } ], "coding_agents": {}, "last_triggered_at": "2025-09-23T21:00:46.696678", "completed_at": null, "repositories": [ { "integration_id": 2933, "url": "https://github.com/getsentry/seer", "external_id": "439438299", "name": "getsentry/seer", "provider": "integrations:github", "default_branch": "main", "is_readable": true, "is_writeable": true } ] } }, "summary": "Autofix in Progress" } } } }, "description": "" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "post": { "operationId": "Start Seer Issue Fix", "description": "Trigger a Seer Issue Fix run for a specific issue.\n\nThe issue fix process can:\n- Identify the root cause of the issue\n- Propose a solution\n- Generate code changes\n- Create a pull request with the fix\n\nThe process runs asynchronously, and you can get the state using the GET endpoint.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "issue_id", "schema": { "type": "integer" }, "description": "The ID of the issue you'd like to query.", "required": true } ], "tags": [ "Seer" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "event_id": { "type": "string", "description": "Run issue fix on a specific event. If not provided, the recommended event for the issue will be used." }, "instruction": { "type": "string", "description": "Optional custom instruction to guide the issue fix process." }, "pr_to_comment_on_url": { "type": "string", "format": "uri", "description": "URL of a pull request where the issue fix should add comments." }, "stopping_point": { "enum": [ "root_cause", "solution", "code_changes", "open_pr" ], "type": "string", "description": "Where the issue fix process should stop. If not provided, will run to root cause.\n\n* `root_cause`\n* `solution`\n* `code_changes`\n* `open_pr`" } } } } } }, "security": [ { "auth_token": [ "event:admin", "event:write" ] } ], "responses": { "202": { "content": { "application/json": { "schema": { "type": "object", "description": "Response type for the POST endpoint", "properties": { "run_id": { "type": "integer" } }, "required": [ "run_id" ] }, "examples": { "SuccessfulAutofixCreation": { "value": { "run_id": 12345 }, "summary": "Successful Autofix Creation" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/events/": { "get": { "operationId": "List an Issue's Events", "description": "Return a list of error events bound to an issue", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "issue_id", "schema": { "type": "integer" }, "description": "The ID of the issue you'd like to query.", "required": true }, { "in": "query", "name": "start", "schema": { "type": "string", "format": "date-time" }, "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "end", "schema": { "type": "string", "format": "date-time" }, "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, { "in": "query", "name": "statsPeriod", "schema": { "type": "string" }, "description": "The period of time for the query, will override the start & end parameters, a number followed by one of:\n- `d` for days\n- `h` for hours\n- `m` for minutes\n- `s` for seconds\n- `w` for weeks\n\nFor example, `24h`, to mean query data starting from 24 hours ago to now." }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." }, { "in": "query", "name": "full", "schema": { "type": "boolean", "default": false }, "description": "Specify true to include the full event body, including the stacktrace, in the event payload." }, { "in": "query", "name": "sample", "schema": { "type": "boolean", "default": false }, "description": "Return events in pseudo-random order. This is deterministic so an identical query will always return the same events in the same order." }, { "in": "query", "name": "query", "schema": { "type": "string" }, "description": "An optional search query for filtering events. See [search syntax](https://docs.sentry.io/concepts/search/) and queryable event properties at [Sentry Search Documentation](https://docs.sentry.io/concepts/search/searchable-properties/events/) for more information. An example query might be `query=transaction:foo AND release:abc`" }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1 }, "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } ], "tags": [ "Events" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "event.type": { "type": "string" }, "groupID": { "type": "string", "nullable": true }, "eventID": { "type": "string" }, "projectID": { "type": "string" }, "message": { "type": "string" }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "culprit": { "type": "string", "nullable": true }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "geo": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "nullable": true }, "tags": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "crashFile": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "crashFile", "culprit", "dateCreated", "event.type", "eventID", "groupID", "id", "location", "message", "metadata", "platform", "projectID", "tags", "title", "user" ] } }, "examples": { "ReturnAListOfErrorEventsBoundToAnIssue": { "value": [ { "eventID": "9fac2ceed9344f2bbfdd1fdacb0ed9b1", "tags": [ { "key": "browser", "value": "Chrome 60.0" }, { "key": "device", "value": "Other" }, { "key": "environment", "value": "production" }, { "value": "fatal", "key": "level" }, { "key": "os", "value": "Mac OS X 10.12.6" }, { "value": "CPython 2.7.16", "key": "runtime" }, { "key": "release", "value": "17642328ead24b51867165985996d04b29310337" }, { "key": "server_name", "value": "web1.example.com" } ], "dateCreated": "2020-09-11T17:46:36Z", "user": null, "message": "", "title": "This is an example Python exception", "id": "dfb1a2d057194e76a4186cc8a5271553", "platform": "python", "event.type": "error", "groupID": "1889724436", "crashFile": null, "location": "example.py:123", "culprit": "/books/new/", "projectID": "49271", "metadata": null } ], "summary": "Return a list of error events bound to an issue" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/events/{event_id}/": { "get": { "operationId": "Retrieve an Issue Event", "description": "Retrieves the details of an issue event.", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "issue_id", "schema": { "type": "integer" }, "description": "The ID of the issue you'd like to query.", "required": true }, { "in": "path", "name": "event_id", "schema": { "type": "string", "enum": [ "latest", "oldest", "recommended" ] }, "description": "The ID of the event to retrieve, or 'latest', 'oldest', or 'recommended'.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." } ], "tags": [ "Events" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "groupID": { "type": "string", "nullable": true }, "eventID": { "type": "string" }, "projectID": { "type": "string" }, "message": { "type": "string", "nullable": true }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "geo": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "nullable": true }, "tags": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "platform": { "type": "string" }, "dateReceived": { "type": "string", "format": "date-time", "nullable": true }, "contexts": { "type": "object", "additionalProperties": {}, "nullable": true }, "size": { "type": "integer", "nullable": true }, "entries": { "type": "array", "items": {} }, "dist": { "type": "string", "nullable": true }, "sdk": { "type": "object", "additionalProperties": { "type": "string" } }, "context": { "type": "object", "additionalProperties": {}, "nullable": true }, "packages": { "type": "object", "additionalProperties": {} }, "type": { "type": "string" }, "metadata": {}, "errors": { "type": "array", "items": {} }, "occurrence": {}, "_meta": { "type": "object", "additionalProperties": {} }, "crashFile": { "type": "string", "nullable": true }, "culprit": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "fingerprints": { "type": "array", "items": { "type": "string" } }, "groupingConfig": {}, "startTimestamp": { "type": "string", "format": "date-time" }, "endTimestamp": { "type": "string", "format": "date-time" }, "measurements": {}, "breakdowns": {}, "release": { "type": "object", "properties": { "id": { "type": "integer" }, "commitCount": { "type": "integer" }, "data": { "type": "object", "additionalProperties": {} }, "dateCreated": { "type": "string", "format": "date-time" }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "deployCount": { "type": "integer" }, "ref": { "type": "string", "nullable": true }, "lastCommit": { "type": "object", "additionalProperties": {}, "nullable": true }, "lastDeploy": { "type": "object", "properties": { "dateStarted": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "id": { "type": "string" }, "environment": { "type": "string" }, "dateFinished": { "type": "string" }, "name": { "type": "string" } }, "required": [ "dateFinished", "environment", "id", "name" ], "nullable": true }, "status": { "type": "string" }, "url": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "versionInfo": { "type": "object", "properties": { "description": { "type": "string" }, "package": { "type": "string", "nullable": true }, "version": { "type": "object", "additionalProperties": {} }, "buildHash": { "type": "string", "nullable": true } }, "required": [ "buildHash", "package", "version" ], "nullable": true } }, "nullable": true }, "userReport": { "type": "object", "properties": { "id": { "type": "string" }, "eventID": { "type": "string" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "comments": { "type": "string" }, "dateCreated": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } }, "required": [ "avatarUrl", "email", "id", "ipAddress", "name", "username" ], "nullable": true }, "event": { "type": "object", "properties": { "id": { "type": "string" }, "eventID": { "type": "string" } }, "required": [ "eventID", "id" ] } }, "required": [ "comments", "dateCreated", "email", "event", "eventID", "id", "name", "user" ], "nullable": true }, "sdkUpdates": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "resolvedWith": { "type": "array", "items": { "type": "string" } }, "nextEventID": { "type": "string", "nullable": true }, "previousEventID": { "type": "string", "nullable": true } }, "required": [ "_meta", "context", "contexts", "dateReceived", "dist", "entries", "errors", "eventID", "groupID", "id", "location", "message", "metadata", "nextEventID", "occurrence", "packages", "platform", "previousEventID", "projectID", "release", "resolvedWith", "sdk", "sdkUpdates", "size", "tags", "title", "type", "user", "userReport" ] }, "examples": { "ReturnAnIssueEvent": { "value": { "groupID": "1341191803", "eventID": "9999aaaaca8b46d797c23c6077c6ff01", "dist": null, "userReport": null, "previousEventID": null, "message": "", "title": "This is an example Python exception", "id": "9999aaafcc8b46d797c23c6077c6ff01", "size": 107762, "errors": [ { "data": { "column": 8, "source": "https://s1.sentry-cdn.com/_static/bloopbloop/sentry/dist/app.js.map", "row": 15 }, "message": "Invalid location in sourcemap", "type": "js_invalid_sourcemap_location" } ], "platform": "javascript", "nextEventID": "99f9e199e9a74a14bfef6196ad741619", "type": "error", "metadata": { "type": "ForbiddenError", "value": "GET /organizations/hellboy-meowmeow/users/ 403" }, "tags": [ { "value": "Chrome 83.0.4103", "key": "browser" }, { "value": "Chrome", "key": "browser.name" }, { "value": "prod", "key": "environment" }, { "value": "yes", "key": "handled" }, { "value": "error", "key": "level" }, { "value": "generic", "key": "mechanism" } ], "dateCreated": "2020-06-17T22:26:56.098086Z", "dateReceived": "2020-06-17T22:26:56.428721Z", "user": { "username": null, "name": "Hell Boy", "ip_address": "192.168.1.1", "email": "hell@boy.cat", "data": { "isStaff": false }, "id": "550747" }, "entries": [ { "type": "exception", "data": { "values": [ { "stacktrace": { "frames": [ { "function": "ignoreOnError", "errors": null, "colNo": 23, "vars": null, "package": null, "absPath": "webpack:////usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers.js", "inApp": false, "lineNo": 71, "module": "usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers", "filename": "/usr/src/getsentry/src/sentry/node_modules/@sentry/browser/esm/helpers.js", "platform": null, "instructionAddr": null, "context": [ [ 66, " }" ], [ 67, " // Attempt to invoke user-land function" ], [ 68, " // NOTE: If you are a Sentry user, and you are seeing this stack frame, it" ], [ 69, " // means the sentry.javascript SDK caught an error invoking your application code. This" ], [ 70, " // is expected behavior and NOT indicative of a bug with sentry.javascript." ], [ 71, " return fn.apply(this, wrappedArguments);" ], [ 72, " // tslint:enable:no-unsafe-any" ], [ 73, " }" ], [ 74, " catch (ex) {" ], [ 75, " ignoreNextOnError();" ], [ 76, " withScope(function (scope) {" ] ], "symbolAddr": null, "trust": null, "symbol": null }, { "function": "apply", "errors": null, "colNo": 24, "vars": null, "package": null, "absPath": "webpack:////usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods.js", "inApp": false, "lineNo": 74, "module": "usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods", "filename": "/usr/src/getsentry/src/sentry/node_modules/reflux-core/lib/PublisherMethods.js", "platform": null, "instructionAddr": null, "context": [ [ 69, " */" ], [ 70, " triggerAsync: function triggerAsync() {" ], [ 71, " var args = arguments," ], [ 72, " me = this;" ], [ 73, " _.nextTick(function () {" ], [ 74, " me.trigger.apply(me, args);" ], [ 75, " });" ], [ 76, " }," ], [ 77, "" ], [ 78, " /**" ], [ 79, " * Wraps the trigger mechanism with a deferral function." ] ], "symbolAddr": null, "trust": null, "symbol": null } ], "framesOmitted": null, "registers": null, "hasSystemFrames": true }, "module": null, "rawStacktrace": { "frames": [ { "function": "a", "errors": null, "colNo": 88800, "vars": null, "package": null, "absPath": "https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "inApp": false, "lineNo": 81, "module": null, "filename": "/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "platform": null, "instructionAddr": null, "context": [ [ 76, "/*!" ], [ 77, " Copyright (c) 2018 Jed Watson." ], [ 78, " Licensed under the MIT License (MIT), see" ], [ 79, " http://jedwatson.github.io/react-select" ], [ 80, "*/" ], [ 81, "{snip} e,t)}));return e.handleEvent?e.handleEvent.apply(this,s):e.apply(this,s)}catch(e){throw c(),Object(o.m)((function(n){n.addEventProcessor((fu {snip}" ], [ 82, "/*!" ], [ 83, " * JavaScript Cookie v2.2.1" ], [ 84, " * https://github.com/js-cookie/js-cookie" ], [ 85, " *" ], [ 86, " * Copyright 2006, 2015 Klaus Hartl & Fagner Brack" ] ], "symbolAddr": null, "trust": null, "symbol": null }, { "function": null, "errors": null, "colNo": 149484, "vars": null, "package": null, "absPath": "https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "inApp": false, "lineNo": 119, "module": null, "filename": "/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js", "platform": null, "instructionAddr": null, "context": [ [ 114, "/* @license" ], [ 115, "Papa Parse" ], [ 116, "v5.2.0" ], [ 117, "https://github.com/mholt/PapaParse" ], [ 118, "License: MIT" ], [ 119, "{snip} (){var e=arguments,t=this;r.nextTick((function(){t.trigger.apply(t,e)}))},deferWith:function(e){var t=this.trigger,n=this,r=function(){t.app {snip}" ], [ 120, "/**!" ], [ 121, " * @fileOverview Kickass library to create and place poppers near their reference elements." ], [ 122, " * @version 1.16.1" ], [ 123, " * @license" ], [ 124, " * Copyright (c) 2016 Federico Zivolo and contributors" ] ], "symbolAddr": null, "trust": null, "symbol": null } ], "framesOmitted": null, "registers": null, "hasSystemFrames": true }, "mechanism": { "type": "generic", "handled": true }, "threadId": null, "value": "GET /organizations/hellboy-meowmeow/users/ 403", "type": "ForbiddenError" } ], "excOmitted": null, "hasSystemFrames": true } }, { "type": "breadcrumbs", "data": { "values": [ { "category": "tracing", "level": "debug", "event_id": null, "timestamp": "2020-06-17T22:26:55.266586Z", "data": null, "message": "[Tracing] pushActivity: idleTransactionStarted#1", "type": "debug" }, { "category": "xhr", "level": "info", "event_id": null, "timestamp": "2020-06-17T22:26:55.619446Z", "data": { "url": "/api/0/internal/health/", "status_code": 200, "method": "GET" }, "message": null, "type": "http" }, { "category": "sentry.transaction", "level": "info", "event_id": null, "timestamp": "2020-06-17T22:26:55.945016Z", "data": null, "message": "7787a027f3fb46c985aaa2287b3f4d09", "type": "default" } ] } }, { "type": "request", "data": { "fragment": null, "cookies": [], "inferredContentType": null, "env": null, "headers": [ [ "User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.97 Safari/537.36" ] ], "url": "https://sentry.io/organizations/hellboy-meowmeow/issues/", "query": [ [ "project", "5236886" ] ], "data": null, "method": null } } ], "packages": {}, "sdk": { "version": "5.17.0", "name": "sentry.javascript.browser" }, "_meta": { "user": null, "context": null, "entries": {}, "contexts": null, "message": null, "packages": null, "tags": {}, "sdk": null }, "contexts": { "ForbiddenError": { "status": 403, "statusText": "Forbidden", "responseJSON": { "detail": "You do not have permission to perform this action." }, "type": "default" }, "browser": { "version": "83.0.4103", "type": "browser", "name": "Chrome" }, "os": { "version": "10", "type": "os", "name": "Windows" }, "trace": { "span_id": "83db1ad17e67dfe7", "type": "trace", "trace_id": "da6caabcd90e45fdb81f6655824a5f88", "op": "navigation" }, "organization": { "type": "default", "id": "323938", "slug": "hellboy-meowmeow" } }, "fingerprints": [ "fbe908cc63d63ea9763fd84cb6bad177" ], "context": { "resp": { "status": 403, "responseJSON": { "detail": "You do not have permission to perform this action." }, "name": "ForbiddenError", "statusText": "Forbidden", "message": "GET /organizations/hellboy-meowmeow/users/ 403", "stack": "Error\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480441\n at u (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:51006)\n at Generator._invoke (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:50794)\n at Generator.A.forEach.e. [as next] (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:165:51429)\n at n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68684)\n at s (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68895)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68954\n at new Promise ()\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:16:68835\n at v (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480924)\n at m (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:480152)\n at t.fetchMemberList (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:902983)\n at t.componentDidMount (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:900527)\n at t.componentDidMount (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:15597)\n at Pc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:101023)\n at t.unstable_runWithPriority (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:3462)\n at Ko (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45529)\n at Rc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:97371)\n at Oc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:87690)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45820\n at t.unstable_runWithPriority (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:3462)\n at Ko (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45529)\n at Zo (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45765)\n at Jo (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:45700)\n at gc (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:84256)\n at Object.enqueueSetState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:181:50481)\n at t.M.setState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:173:1439)\n at t.onUpdate (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:543076)\n at a.n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149090)\n at a.emit (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:6550)\n at p.trigger (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149379)\n at p.onInitializeUrlState (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/app.js:1:541711)\n at a.n (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149090)\n at a.emit (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:189:6550)\n at Function.trigger (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149379)\n at https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:119:149484\n at a (https://s1.sentry-cdn.com/_static/dde778f9f93a48e2b6e58ecb0c5eb8f2/sentry/dist/vendor.js:81:88800)" } }, "release": { "dateReleased": "2020-06-17T19:21:02.186004Z", "commitCount": 11, "url": "https://freight.getsentry.net/deploys/getsentry/production/8868/", "data": {}, "lastDeploy": { "name": "b65bc521378269d3eaefdc964f8ef56621414943 to prod", "url": null, "environment": "prod", "dateStarted": null, "dateFinished": "2020-06-17T19:20:55.641748Z", "id": "6883490" }, "deployCount": 1, "dateCreated": "2020-06-17T18:45:31.042157Z", "version": "b65bc521378269d3eaefdc964f8ef56621414943", "lastCommit": { "repository": { "status": "active", "integrationId": "2933", "externalSlug": "getsentry/getsentry", "name": "getsentry/getsentry", "provider": { "id": "integrations:github", "name": "GitHub" }, "url": "https://github.com/getsentry/getsentry", "id": "2", "dateCreated": "2016-10-10T21:36:45.373994Z" }, "releases": [ { "dateReleased": "2020-06-23T13:26:18.427090Z", "url": "https://freight.getsentry.net/deploys/getsentry/staging/2077/", "dateCreated": "2020-06-23T13:22:50.420265Z", "version": "f3783e5fe710758724f14267439fd46cc2bf5918", "shortVersion": "f3783e5fe710758724f14267439fd46cc2bf5918", "ref": "perf/source-maps-test" }, { "dateReleased": "2020-06-17T19:21:02.186004Z", "url": "https://freight.getsentry.net/deploys/getsentry/production/8868/", "dateCreated": "2020-06-17T18:45:31.042157Z", "version": "b65bc521378269d3eaefdc964f8ef56621414943", "shortVersion": "b65bc521378269d3eaefdc964f8ef56621414943", "ref": "master" } ], "dateCreated": "2020-06-17T18:43:37Z", "message": "feat(billing): Get a lot of money", "id": "b65bc521378269d3eaefdc964f8ef56621414943" }, "ref": "master" }, "crashFile": null, "location": "example.py:123", "culprit": "/books/new/", "groupingConfig": { "enhancements": "abc", "id": "2359823092345612392" }, "occurrence": null, "projectID": "5236886", "resolvedWith": [], "sdkUpdates": [] }, "summary": "Return an issue event" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/external-issues/": { "get": { "operationId": "Retrieve custom integration issue links for the given Sentry issue", "description": "Retrieve custom integration issue links for the given Sentry issue", "parameters": [ { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "issue_id", "schema": { "type": "integer" }, "description": "The ID of the issue you'd like to query.", "required": true } ], "tags": [ "Integration" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "issueId": { "type": "string" }, "serviceType": { "type": "string" }, "displayName": { "type": "string" }, "webUrl": { "type": "string" } }, "required": [ "displayName", "id", "issueId", "serviceType", "webUrl" ] } }, "examples": { "RetrieveTheCustomIntegrationsAssociatedWithAnIssueId": { "value": [ { "id": "123456", "issueId": "1234567890", "serviceType": "example-app", "displayName": "example-issue#2", "webUrl": "https://example.com/my-test-project/issue/example-issue-2/this-is-an-example-python-exception" } ], "summary": "Retrieve the custom integrations associated with an issue id" } } } }, "description": "" } } } }, "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/tags/{key}/": { "get": { "operationId": "Retrieve Tag Details", "description": "Return a list of values associated with this key for an issue. When paginated can return at most 1000 values.", "parameters": [ { "in": "path", "name": "issue_id", "schema": { "type": "integer" }, "description": "The ID of the issue you'd like to query.", "required": true }, { "in": "path", "name": "organization_id_or_slug", "schema": { "type": "string" }, "description": "The ID or slug of the organization the resource belongs to.", "required": true }, { "in": "path", "name": "key", "schema": { "type": "string" }, "description": "The tag key to look the values up for.", "required": true }, { "in": "query", "name": "environment", "schema": { "type": "array", "items": { "type": "string" } }, "description": "The name of environments to filter by." } ], "tags": [ "Events" ], "security": [ { "auth_token": [ "event:admin", "event:read", "event:write" ] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uniqueValues": { "type": "integer", "nullable": true }, "totalValues": { "type": "integer", "nullable": true }, "topValues": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "key": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string", "nullable": true }, "count": { "type": "integer", "nullable": true }, "lastSeen": { "type": "string", "nullable": true }, "firstSeen": { "type": "string", "nullable": true } }, "required": [ "count", "firstSeen", "key", "lastSeen", "name", "value" ] }, "nullable": true }, "key": { "type": "string" }, "name": { "type": "string" } }, "required": [ "key", "name" ] }, "examples": { "ReturnASpecificTag'sDetails": { "value": { "key": "flavors", "name": "Flavors", "uniqueValues": 2, "totalValues": 3, "topValues": [ { "key": "strawberry", "name": "Strawberry", "value": "strawberry", "count": 2, "lastSeen": "2024-01-01T00:00:00Z", "firstSeen": "2024-01-01T00:00:00Z" }, { "key": "vanilla", "name": "Vanilla", "value": "vanilla", "count": 1, "lastSeen": "2024-01-01T00:00:00Z", "firstSeen": "2024-01-01T00:00:00Z" } ] }, "summary": "Return a specific tag's details" } } } }, "description": "" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } } }, "components": { "schemas": { "AutofixPostResponse": { "type": "object", "description": "Response type for the POST endpoint", "properties": { "run_id": { "type": "integer" } }, "required": [ "run_id" ] }, "AutofixRequest": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "event_id": { "type": "string", "description": "Run issue fix on a specific event. If not provided, the recommended event for the issue will be used." }, "instruction": { "type": "string", "description": "Optional custom instruction to guide the issue fix process." }, "pr_to_comment_on_url": { "type": "string", "format": "uri", "description": "URL of a pull request where the issue fix should add comments." }, "stopping_point": { "enum": [ "root_cause", "solution", "code_changes", "open_pr" ], "type": "string", "description": "Where the issue fix process should stop. If not provided, will run to root cause.\n\n* `root_cause`\n* `solution`\n* `code_changes`\n* `open_pr`" } } }, "AutofixStateResponse": { "type": "object", "description": "Response type for the GET endpoint", "properties": { "autofix": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "autofix" ] }, "BaseDataConditionGroupValidator": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "logic_type": { "enum": [ "any", "any-short", "all", "none" ], "type": "string", "description": "* `any`\n* `any-short`\n* `all`\n* `none`" }, "conditions": { "type": "array", "items": {} } }, "required": [ "logic_type" ] }, "BaseDetectorTypeValidator": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "name": { "type": "string", "description": "Name of the monitor.", "maxLength": 200 }, "type": { "type": "string", "description": "The type of monitor - `metric_issue`." }, "workflow_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the alerts to connect this monitor to. Use the 'Fetch Alerts' endpoint to find the IDs." }, "data_sources": { "type": "array", "items": {}, "description": "\n The data sources for the monitor to use based on what you want to measure.\n\n **Number of Errors Metric Monitor**\n - `eventTypes`: Any of `error` or `default`.\n ```json\n [\n {\n \"aggregate\": \"count()\",\n \"dataset\" : \"events\",\n \"environment\": \"prod\",\n \"eventTypes\": [\"default\", \"error\"],\n \"query\": \"is:unresolved\",\n \"queryType\": 0,\n \"timeWindow\": 3600,\n },\n ],\n ```\n\n **Users Experiencing Errors Metric Monitor**\n - `eventTypes`: Any of `error` or `default`.\n ```json\n [\n {\n \"aggregate\": \"count_unique(tags[sentry:user])\",\n \"dataset\" : \"events\",\n \"environment\": \"prod\",\n \"eventTypes\": [\"default\", \"error\"],\n \"query\": \"is:unresolved\",\n \"queryType\": 0,\n \"timeWindow\": 3600,\n },\n ],\n ```\n\n\n **Throughput Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"count(span.duration)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Duration Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"p95(span.duration)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Failure Rate Metric Monitor**\n ```json\n [\n {\n \"aggregate\":\"failure_rate()\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Largest Contentful Paint Metric Monitor**\n - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.\n - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile.\n\n ```json\n [\n {\n \"aggregate\":\"p95(measurements.lcp)\",\n \"dataset\":\"events_analytics_platform\",\n \"environment\":\"prod\",\n \"eventTypes\":[\"trace_item_span\"]\n \"query\":\"\",\n \"queryType\":1,\n \"timeWindow\":3600,\n \"extrapolationMode\":\"unknown\",\n },\n ],\n ```\n\n **Custom Metric Monitor**\n - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`.\n - `aggregate`: Valid values are:\n `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p75(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`.\n `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile.\n `failure_rate()`\n `apdex(x)`, where `x` is the value of the Apdex score.\n `count()`\n\n ```json\n [\n {\n \"aggregate\": \"p75(measurements.ttfb)\"\n \"dataset\": \"events_analytics_platform\",\n \"queryType\": 1,\n },\n ],\n" }, "config": { "type": "object", "additionalProperties": {}, "description": "\n The issue detection type configuration.\n\n\n - `detectionType`\n - `static`: Threshold based monitor\n - `percent`: Change based monitor\n - `dynamic`: Dynamic monitor\n - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes.\n For example, a value of 3600 compares the metric tracked against data 1 hour ago.\n - `300`: 5 minutes\n - `900`: 15 minutes\n - `3600`: 1 hour\n - `86400`: 1 day\n - `604800`: 1 week\n - `2592000`: 1 month\n\n **Threshold**\n ```json\n {\n \"detectionType\": \"static\",\n }\n ```\n **Change**\n ```json\n {\n \"detectionType\": \"percent\",\n \"comparisonDelta\": 3600,\n }\n ```\n **Dynamic**\n ```json\n {\n \"detectionType\": \"dynamic\",\n }\n ```\n " }, "condition_group": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "logic_type": { "enum": [ "any", "any-short", "all", "none" ], "type": "string", "description": "* `any`\n* `any-short`\n* `all`\n* `none`" }, "conditions": { "type": "array", "items": {} } }, "required": [ "logic_type" ] } ], "description": "\n Issue detection configuration for when to create an issue and at what priority level.\n\n\n - `logicType`: `any`\n - `type`: Any of `gt` (greater than), `lte` (less than or equal), or `anomaly_detection` (dynamic)\n - `comparison`: Any positive integer. This is threshold that must be crossed for the monitor to create an issue, e.g. \"Create a metric issue when there are more than 5 unresolved error events\".\n - If creating a **dynamic** monitor, see the options below.\n - `seasonality`: `auto`\n - `sensitivity`: Level of responsiveness. Options are one of `low`, `medium`, or `high`\n - `thresholdType`: If you want to be alerted to anomalies that are moving above, below, or in both directions in relation to your threshold.\n - `0`: Above\n - `1`: Below\n - `2`: Above and below\n\n - `conditionResult`: The issue state change when the threshold is crossed.\n - `75`: High priority\n - `50`: Low priority\n - `0`: Resolved\n\n\n **Threshold and Change Monitor**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"gt\",\n \"comparison\": 10,\n \"conditionResult\": 75\n },\n {\n \"type\": \"lte\",\n \"comparison\": 10,\n \"conditionResult\": 0\n }\n ],\n \"actions\": []\n ```\n\n **Threshold Monitor with Medium Priority**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n type: \"gt\",\n comparison: 5,\n conditionResult: 75\n },\n {\n type: \"gt\",\n comparison: 2,\n conditionResult: 50\n },\n {\n type: \"lte\",\n comparison: 2,\n conditionResult: 0\n }\n ],\n \"actions\": []\n ```\n\n **Dynamic Monitor**\n ```json\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"anomaly_detection\",\n \"comparison\": {\n \"seasonality\": \"auto\",\n \"sensitivity\": \"medium\",\n \"thresholdType\": 2\n },\n \"conditionResult\": 75\n }\n ],\n \"actions\": []\n ```\n " }, "owner": { "type": "string", "nullable": true, "description": "\n The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'.\n\n **User**\n ```json\n \"user:123456\"\n ```\n\n **Team**\n ```json\n \"team:456789\"\n ```\n " }, "description": { "type": "string", "nullable": true, "description": "A description of the monitor. Will be used in the resulting issue." }, "enabled": { "type": "boolean", "description": "Set to False if you want to disable the monitor." } }, "required": [ "name", "type" ] }, "BaseTeam": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] }, "BranchNode": { "type": "object", "description": "Serializer for individual branch nodes from GraphQL response", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "Branches": { "type": "object", "description": "Serializer for repository branches response", "properties": { "defaultBranch": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "description": "Serializer for individual branch nodes from GraphQL response", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } }, "pageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "totalCount": { "type": "integer" } }, "required": [ "defaultBranch", "pageInfo", "results", "totalCount" ] }, "BulkUpdateAlerts": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether to enable or disable the alerts" } }, "required": [ "enabled" ] }, "BulkUpdateMonitors": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether to enable or disable the monitors" } }, "required": [ "enabled" ] }, "CheckInList": { "type": "array", "items": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "duration": { "type": "integer", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dateInProgress": { "type": "string", "format": "date-time", "nullable": true }, "dateClock": { "type": "string", "format": "date-time" }, "expectedTime": { "type": "string", "format": "date-time" }, "monitorConfig": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] } }, "required": [ "dateAdded", "dateClock", "dateCreated", "dateInProgress", "dateUpdated", "duration", "environment", "expectedTime", "id", "monitorConfig", "status" ] } }, "Commit": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 64 }, "repository": { "type": "string", "nullable": true, "maxLength": 64 }, "message": { "type": "string", "nullable": true }, "author_name": { "type": "string", "nullable": true, "maxLength": 128 }, "author_email": { "type": "string", "nullable": true, "maxLength": 200 }, "timestamp": { "type": "string", "format": "date-time", "nullable": true }, "patch_set": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "maxLength": 510 }, "type": { "type": "string", "maxLength": 1 } }, "required": [ "path", "type" ] }, "nullable": true } }, "required": [ "id" ] }, "CommitPatchSet": { "type": "object", "properties": { "path": { "type": "string", "maxLength": 510 }, "type": { "type": "string", "maxLength": 1 } }, "required": [ "path", "type" ] }, "CommitSerializerResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "pullRequest": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "repository": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "nullable": true }, "provider": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "integrationId": { "type": "string", "nullable": true }, "externalSlug": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "settings": { "type": "object", "properties": { "enabledCodeReview": { "type": "boolean" }, "codeReviewTriggers": { "type": "array", "items": { "type": "string" } } }, "required": [ "codeReviewTriggers", "enabledCodeReview" ], "nullable": true } } }, "author": { "anyOf": [ { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string" } }, "required": [ "email", "name" ] } ] }, "externalUrl": { "type": "string" } }, "required": [ "author", "dateCreated", "externalUrl", "id", "message", "repository", "title" ], "nullable": true }, "suspectCommitType": { "type": "string" }, "repository": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "nullable": true }, "provider": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "integrationId": { "type": "string", "nullable": true }, "externalSlug": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "settings": { "type": "object", "properties": { "enabledCodeReview": { "type": "boolean" }, "codeReviewTriggers": { "type": "array", "items": { "type": "string" } } }, "required": [ "codeReviewTriggers", "enabledCodeReview" ], "nullable": true } } }, "author": { "anyOf": [ { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string" } }, "required": [ "email", "name" ] } ] } }, "required": [ "dateCreated", "id", "message", "pullRequest", "suspectCommitType" ] } }, "ConfigValidator": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string", "description": "Currently supports \"crontab\" or \"interval\"\n\n* `crontab`\n* `interval`" }, "schedule": { "description": "Varies depending on the schedule_type. Is either a crontab string, or a 2 element tuple for intervals (e.g. [1, 'day'])" }, "checkin_margin": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) after the expected checkin time will we wait until we consider the checkin to have been missed." }, "max_runtime": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) is the checkin allowed to run for in CheckInStatus.IN_PROGRESS before it is considered failed." }, "timezone": { "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "localtime", "" ], "type": "string", "description": "tz database style timezone string\n\n* `Africa/Abidjan`\n* `Africa/Accra`\n* `Africa/Addis_Ababa`\n* `Africa/Algiers`\n* `Africa/Asmara`\n* `Africa/Asmera`\n* `Africa/Bamako`\n* `Africa/Bangui`\n* `Africa/Banjul`\n* `Africa/Bissau`\n* `Africa/Blantyre`\n* `Africa/Brazzaville`\n* `Africa/Bujumbura`\n* `Africa/Cairo`\n* `Africa/Casablanca`\n* `Africa/Ceuta`\n* `Africa/Conakry`\n* `Africa/Dakar`\n* `Africa/Dar_es_Salaam`\n* `Africa/Djibouti`\n* `Africa/Douala`\n* `Africa/El_Aaiun`\n* `Africa/Freetown`\n* `Africa/Gaborone`\n* `Africa/Harare`\n* `Africa/Johannesburg`\n* `Africa/Juba`\n* `Africa/Kampala`\n* `Africa/Khartoum`\n* `Africa/Kigali`\n* `Africa/Kinshasa`\n* `Africa/Lagos`\n* `Africa/Libreville`\n* `Africa/Lome`\n* `Africa/Luanda`\n* `Africa/Lubumbashi`\n* `Africa/Lusaka`\n* `Africa/Malabo`\n* `Africa/Maputo`\n* `Africa/Maseru`\n* `Africa/Mbabane`\n* `Africa/Mogadishu`\n* `Africa/Monrovia`\n* `Africa/Nairobi`\n* `Africa/Ndjamena`\n* `Africa/Niamey`\n* `Africa/Nouakchott`\n* `Africa/Ouagadougou`\n* `Africa/Porto-Novo`\n* `Africa/Sao_Tome`\n* `Africa/Timbuktu`\n* `Africa/Tripoli`\n* `Africa/Tunis`\n* `Africa/Windhoek`\n* `America/Adak`\n* `America/Anchorage`\n* `America/Anguilla`\n* `America/Antigua`\n* `America/Araguaina`\n* `America/Argentina/Buenos_Aires`\n* `America/Argentina/Catamarca`\n* `America/Argentina/ComodRivadavia`\n* `America/Argentina/Cordoba`\n* `America/Argentina/Jujuy`\n* `America/Argentina/La_Rioja`\n* `America/Argentina/Mendoza`\n* `America/Argentina/Rio_Gallegos`\n* `America/Argentina/Salta`\n* `America/Argentina/San_Juan`\n* `America/Argentina/San_Luis`\n* `America/Argentina/Tucuman`\n* `America/Argentina/Ushuaia`\n* `America/Aruba`\n* `America/Asuncion`\n* `America/Atikokan`\n* `America/Atka`\n* `America/Bahia`\n* `America/Bahia_Banderas`\n* `America/Barbados`\n* `America/Belem`\n* `America/Belize`\n* `America/Blanc-Sablon`\n* `America/Boa_Vista`\n* `America/Bogota`\n* `America/Boise`\n* `America/Buenos_Aires`\n* `America/Cambridge_Bay`\n* `America/Campo_Grande`\n* `America/Cancun`\n* `America/Caracas`\n* `America/Catamarca`\n* `America/Cayenne`\n* `America/Cayman`\n* `America/Chicago`\n* `America/Chihuahua`\n* `America/Ciudad_Juarez`\n* `America/Coral_Harbour`\n* `America/Cordoba`\n* `America/Costa_Rica`\n* `America/Coyhaique`\n* `America/Creston`\n* `America/Cuiaba`\n* `America/Curacao`\n* `America/Danmarkshavn`\n* `America/Dawson`\n* `America/Dawson_Creek`\n* `America/Denver`\n* `America/Detroit`\n* `America/Dominica`\n* `America/Edmonton`\n* `America/Eirunepe`\n* `America/El_Salvador`\n* `America/Ensenada`\n* `America/Fort_Nelson`\n* `America/Fort_Wayne`\n* `America/Fortaleza`\n* `America/Glace_Bay`\n* `America/Godthab`\n* `America/Goose_Bay`\n* `America/Grand_Turk`\n* `America/Grenada`\n* `America/Guadeloupe`\n* `America/Guatemala`\n* `America/Guayaquil`\n* `America/Guyana`\n* `America/Halifax`\n* `America/Havana`\n* `America/Hermosillo`\n* `America/Indiana/Indianapolis`\n* `America/Indiana/Knox`\n* `America/Indiana/Marengo`\n* `America/Indiana/Petersburg`\n* `America/Indiana/Tell_City`\n* `America/Indiana/Vevay`\n* `America/Indiana/Vincennes`\n* `America/Indiana/Winamac`\n* `America/Indianapolis`\n* `America/Inuvik`\n* `America/Iqaluit`\n* `America/Jamaica`\n* `America/Jujuy`\n* `America/Juneau`\n* `America/Kentucky/Louisville`\n* `America/Kentucky/Monticello`\n* `America/Knox_IN`\n* `America/Kralendijk`\n* `America/La_Paz`\n* `America/Lima`\n* `America/Los_Angeles`\n* `America/Louisville`\n* `America/Lower_Princes`\n* `America/Maceio`\n* `America/Managua`\n* `America/Manaus`\n* `America/Marigot`\n* `America/Martinique`\n* `America/Matamoros`\n* `America/Mazatlan`\n* `America/Mendoza`\n* `America/Menominee`\n* `America/Merida`\n* `America/Metlakatla`\n* `America/Mexico_City`\n* `America/Miquelon`\n* `America/Moncton`\n* `America/Monterrey`\n* `America/Montevideo`\n* `America/Montreal`\n* `America/Montserrat`\n* `America/Nassau`\n* `America/New_York`\n* `America/Nipigon`\n* `America/Nome`\n* `America/Noronha`\n* `America/North_Dakota/Beulah`\n* `America/North_Dakota/Center`\n* `America/North_Dakota/New_Salem`\n* `America/Nuuk`\n* `America/Ojinaga`\n* `America/Panama`\n* `America/Pangnirtung`\n* `America/Paramaribo`\n* `America/Phoenix`\n* `America/Port-au-Prince`\n* `America/Port_of_Spain`\n* `America/Porto_Acre`\n* `America/Porto_Velho`\n* `America/Puerto_Rico`\n* `America/Punta_Arenas`\n* `America/Rainy_River`\n* `America/Rankin_Inlet`\n* `America/Recife`\n* `America/Regina`\n* `America/Resolute`\n* `America/Rio_Branco`\n* `America/Rosario`\n* `America/Santa_Isabel`\n* `America/Santarem`\n* `America/Santiago`\n* `America/Santo_Domingo`\n* `America/Sao_Paulo`\n* `America/Scoresbysund`\n* `America/Shiprock`\n* `America/Sitka`\n* `America/St_Barthelemy`\n* `America/St_Johns`\n* `America/St_Kitts`\n* `America/St_Lucia`\n* `America/St_Thomas`\n* `America/St_Vincent`\n* `America/Swift_Current`\n* `America/Tegucigalpa`\n* `America/Thule`\n* `America/Thunder_Bay`\n* `America/Tijuana`\n* `America/Toronto`\n* `America/Tortola`\n* `America/Vancouver`\n* `America/Virgin`\n* `America/Whitehorse`\n* `America/Winnipeg`\n* `America/Yakutat`\n* `America/Yellowknife`\n* `Antarctica/Casey`\n* `Antarctica/Davis`\n* `Antarctica/DumontDUrville`\n* `Antarctica/Macquarie`\n* `Antarctica/Mawson`\n* `Antarctica/McMurdo`\n* `Antarctica/Palmer`\n* `Antarctica/Rothera`\n* `Antarctica/South_Pole`\n* `Antarctica/Syowa`\n* `Antarctica/Troll`\n* `Antarctica/Vostok`\n* `Arctic/Longyearbyen`\n* `Asia/Aden`\n* `Asia/Almaty`\n* `Asia/Amman`\n* `Asia/Anadyr`\n* `Asia/Aqtau`\n* `Asia/Aqtobe`\n* `Asia/Ashgabat`\n* `Asia/Ashkhabad`\n* `Asia/Atyrau`\n* `Asia/Baghdad`\n* `Asia/Bahrain`\n* `Asia/Baku`\n* `Asia/Bangkok`\n* `Asia/Barnaul`\n* `Asia/Beirut`\n* `Asia/Bishkek`\n* `Asia/Brunei`\n* `Asia/Calcutta`\n* `Asia/Chita`\n* `Asia/Choibalsan`\n* `Asia/Chongqing`\n* `Asia/Chungking`\n* `Asia/Colombo`\n* `Asia/Dacca`\n* `Asia/Damascus`\n* `Asia/Dhaka`\n* `Asia/Dili`\n* `Asia/Dubai`\n* `Asia/Dushanbe`\n* `Asia/Famagusta`\n* `Asia/Gaza`\n* `Asia/Harbin`\n* `Asia/Hebron`\n* `Asia/Ho_Chi_Minh`\n* `Asia/Hong_Kong`\n* `Asia/Hovd`\n* `Asia/Irkutsk`\n* `Asia/Istanbul`\n* `Asia/Jakarta`\n* `Asia/Jayapura`\n* `Asia/Jerusalem`\n* `Asia/Kabul`\n* `Asia/Kamchatka`\n* `Asia/Karachi`\n* `Asia/Kashgar`\n* `Asia/Kathmandu`\n* `Asia/Katmandu`\n* `Asia/Khandyga`\n* `Asia/Kolkata`\n* `Asia/Krasnoyarsk`\n* `Asia/Kuala_Lumpur`\n* `Asia/Kuching`\n* `Asia/Kuwait`\n* `Asia/Macao`\n* `Asia/Macau`\n* `Asia/Magadan`\n* `Asia/Makassar`\n* `Asia/Manila`\n* `Asia/Muscat`\n* `Asia/Nicosia`\n* `Asia/Novokuznetsk`\n* `Asia/Novosibirsk`\n* `Asia/Omsk`\n* `Asia/Oral`\n* `Asia/Phnom_Penh`\n* `Asia/Pontianak`\n* `Asia/Pyongyang`\n* `Asia/Qatar`\n* `Asia/Qostanay`\n* `Asia/Qyzylorda`\n* `Asia/Rangoon`\n* `Asia/Riyadh`\n* `Asia/Saigon`\n* `Asia/Sakhalin`\n* `Asia/Samarkand`\n* `Asia/Seoul`\n* `Asia/Shanghai`\n* `Asia/Singapore`\n* `Asia/Srednekolymsk`\n* `Asia/Taipei`\n* `Asia/Tashkent`\n* `Asia/Tbilisi`\n* `Asia/Tehran`\n* `Asia/Tel_Aviv`\n* `Asia/Thimbu`\n* `Asia/Thimphu`\n* `Asia/Tokyo`\n* `Asia/Tomsk`\n* `Asia/Ujung_Pandang`\n* `Asia/Ulaanbaatar`\n* `Asia/Ulan_Bator`\n* `Asia/Urumqi`\n* `Asia/Ust-Nera`\n* `Asia/Vientiane`\n* `Asia/Vladivostok`\n* `Asia/Yakutsk`\n* `Asia/Yangon`\n* `Asia/Yekaterinburg`\n* `Asia/Yerevan`\n* `Atlantic/Azores`\n* `Atlantic/Bermuda`\n* `Atlantic/Canary`\n* `Atlantic/Cape_Verde`\n* `Atlantic/Faeroe`\n* `Atlantic/Faroe`\n* `Atlantic/Jan_Mayen`\n* `Atlantic/Madeira`\n* `Atlantic/Reykjavik`\n* `Atlantic/South_Georgia`\n* `Atlantic/St_Helena`\n* `Atlantic/Stanley`\n* `Australia/ACT`\n* `Australia/Adelaide`\n* `Australia/Brisbane`\n* `Australia/Broken_Hill`\n* `Australia/Canberra`\n* `Australia/Currie`\n* `Australia/Darwin`\n* `Australia/Eucla`\n* `Australia/Hobart`\n* `Australia/LHI`\n* `Australia/Lindeman`\n* `Australia/Lord_Howe`\n* `Australia/Melbourne`\n* `Australia/NSW`\n* `Australia/North`\n* `Australia/Perth`\n* `Australia/Queensland`\n* `Australia/South`\n* `Australia/Sydney`\n* `Australia/Tasmania`\n* `Australia/Victoria`\n* `Australia/West`\n* `Australia/Yancowinna`\n* `Brazil/Acre`\n* `Brazil/DeNoronha`\n* `Brazil/East`\n* `Brazil/West`\n* `CET`\n* `CST6CDT`\n* `Canada/Atlantic`\n* `Canada/Central`\n* `Canada/Eastern`\n* `Canada/Mountain`\n* `Canada/Newfoundland`\n* `Canada/Pacific`\n* `Canada/Saskatchewan`\n* `Canada/Yukon`\n* `Chile/Continental`\n* `Chile/EasterIsland`\n* `Cuba`\n* `EET`\n* `EST`\n* `EST5EDT`\n* `Egypt`\n* `Eire`\n* `Etc/GMT`\n* `Etc/GMT+0`\n* `Etc/GMT+1`\n* `Etc/GMT+10`\n* `Etc/GMT+11`\n* `Etc/GMT+12`\n* `Etc/GMT+2`\n* `Etc/GMT+3`\n* `Etc/GMT+4`\n* `Etc/GMT+5`\n* `Etc/GMT+6`\n* `Etc/GMT+7`\n* `Etc/GMT+8`\n* `Etc/GMT+9`\n* `Etc/GMT-0`\n* `Etc/GMT-1`\n* `Etc/GMT-10`\n* `Etc/GMT-11`\n* `Etc/GMT-12`\n* `Etc/GMT-13`\n* `Etc/GMT-14`\n* `Etc/GMT-2`\n* `Etc/GMT-3`\n* `Etc/GMT-4`\n* `Etc/GMT-5`\n* `Etc/GMT-6`\n* `Etc/GMT-7`\n* `Etc/GMT-8`\n* `Etc/GMT-9`\n* `Etc/GMT0`\n* `Etc/Greenwich`\n* `Etc/UCT`\n* `Etc/UTC`\n* `Etc/Universal`\n* `Etc/Zulu`\n* `Europe/Amsterdam`\n* `Europe/Andorra`\n* `Europe/Astrakhan`\n* `Europe/Athens`\n* `Europe/Belfast`\n* `Europe/Belgrade`\n* `Europe/Berlin`\n* `Europe/Bratislava`\n* `Europe/Brussels`\n* `Europe/Bucharest`\n* `Europe/Budapest`\n* `Europe/Busingen`\n* `Europe/Chisinau`\n* `Europe/Copenhagen`\n* `Europe/Dublin`\n* `Europe/Gibraltar`\n* `Europe/Guernsey`\n* `Europe/Helsinki`\n* `Europe/Isle_of_Man`\n* `Europe/Istanbul`\n* `Europe/Jersey`\n* `Europe/Kaliningrad`\n* `Europe/Kiev`\n* `Europe/Kirov`\n* `Europe/Kyiv`\n* `Europe/Lisbon`\n* `Europe/Ljubljana`\n* `Europe/London`\n* `Europe/Luxembourg`\n* `Europe/Madrid`\n* `Europe/Malta`\n* `Europe/Mariehamn`\n* `Europe/Minsk`\n* `Europe/Monaco`\n* `Europe/Moscow`\n* `Europe/Nicosia`\n* `Europe/Oslo`\n* `Europe/Paris`\n* `Europe/Podgorica`\n* `Europe/Prague`\n* `Europe/Riga`\n* `Europe/Rome`\n* `Europe/Samara`\n* `Europe/San_Marino`\n* `Europe/Sarajevo`\n* `Europe/Saratov`\n* `Europe/Simferopol`\n* `Europe/Skopje`\n* `Europe/Sofia`\n* `Europe/Stockholm`\n* `Europe/Tallinn`\n* `Europe/Tirane`\n* `Europe/Tiraspol`\n* `Europe/Ulyanovsk`\n* `Europe/Uzhgorod`\n* `Europe/Vaduz`\n* `Europe/Vatican`\n* `Europe/Vienna`\n* `Europe/Vilnius`\n* `Europe/Volgograd`\n* `Europe/Warsaw`\n* `Europe/Zagreb`\n* `Europe/Zaporozhye`\n* `Europe/Zurich`\n* `GB`\n* `GB-Eire`\n* `GMT`\n* `GMT+0`\n* `GMT-0`\n* `GMT0`\n* `Greenwich`\n* `HST`\n* `Hongkong`\n* `Iceland`\n* `Indian/Antananarivo`\n* `Indian/Chagos`\n* `Indian/Christmas`\n* `Indian/Cocos`\n* `Indian/Comoro`\n* `Indian/Kerguelen`\n* `Indian/Mahe`\n* `Indian/Maldives`\n* `Indian/Mauritius`\n* `Indian/Mayotte`\n* `Indian/Reunion`\n* `Iran`\n* `Israel`\n* `Jamaica`\n* `Japan`\n* `Kwajalein`\n* `Libya`\n* `MET`\n* `MST`\n* `MST7MDT`\n* `Mexico/BajaNorte`\n* `Mexico/BajaSur`\n* `Mexico/General`\n* `NZ`\n* `NZ-CHAT`\n* `Navajo`\n* `PRC`\n* `PST8PDT`\n* `Pacific/Apia`\n* `Pacific/Auckland`\n* `Pacific/Bougainville`\n* `Pacific/Chatham`\n* `Pacific/Chuuk`\n* `Pacific/Easter`\n* `Pacific/Efate`\n* `Pacific/Enderbury`\n* `Pacific/Fakaofo`\n* `Pacific/Fiji`\n* `Pacific/Funafuti`\n* `Pacific/Galapagos`\n* `Pacific/Gambier`\n* `Pacific/Guadalcanal`\n* `Pacific/Guam`\n* `Pacific/Honolulu`\n* `Pacific/Johnston`\n* `Pacific/Kanton`\n* `Pacific/Kiritimati`\n* `Pacific/Kosrae`\n* `Pacific/Kwajalein`\n* `Pacific/Majuro`\n* `Pacific/Marquesas`\n* `Pacific/Midway`\n* `Pacific/Nauru`\n* `Pacific/Niue`\n* `Pacific/Norfolk`\n* `Pacific/Noumea`\n* `Pacific/Pago_Pago`\n* `Pacific/Palau`\n* `Pacific/Pitcairn`\n* `Pacific/Pohnpei`\n* `Pacific/Ponape`\n* `Pacific/Port_Moresby`\n* `Pacific/Rarotonga`\n* `Pacific/Saipan`\n* `Pacific/Samoa`\n* `Pacific/Tahiti`\n* `Pacific/Tarawa`\n* `Pacific/Tongatapu`\n* `Pacific/Truk`\n* `Pacific/Wake`\n* `Pacific/Wallis`\n* `Pacific/Yap`\n* `Poland`\n* `Portugal`\n* `ROC`\n* `ROK`\n* `Singapore`\n* `Turkey`\n* `UCT`\n* `US/Alaska`\n* `US/Aleutian`\n* `US/Arizona`\n* `US/Central`\n* `US/East-Indiana`\n* `US/Eastern`\n* `US/Hawaii`\n* `US/Indiana-Starke`\n* `US/Michigan`\n* `US/Mountain`\n* `US/Pacific`\n* `US/Samoa`\n* `UTC`\n* `Universal`\n* `W-SU`\n* `WET`\n* `Zulu`\n* `localtime`" }, "failure_issue_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many consecutive missed or failed check-ins in a row before creating a new issue." }, "recovery_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many successful check-ins in a row before resolving an issue." } }, "required": [ "schedule" ] }, "CreateReplayDeletionJob": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "rangeStart": { "type": "string" }, "rangeEnd": { "type": "string" }, "environments": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "query": { "type": "string" }, "countDeleted": { "type": "integer" } }, "required": [ "countDeleted", "dateCreated", "dateUpdated", "environments", "id", "query", "rangeEnd", "rangeStart", "status" ] } }, "required": [ "data" ] }, "Dashboard": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "title": { "type": "string", "description": "The user defined title for this dashboard.", "maxLength": 255 }, "id": { "type": "string", "description": "A dashboard's unique id." }, "widgets": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "thresholds": { "type": "object", "additionalProperties": {}, "nullable": true }, "display_type": { "enum": [ "line", "area", "bar", "table", "big_number", "details", "categorical_bar", "wheel", "rage_and_dead_clicks", "server_tree", "text", "agents_traces_table" ], "type": "string", "description": "* `line`\n* `area`\n* `bar`\n* `table`\n* `big_number`\n* `details`\n* `categorical_bar`\n* `wheel`\n* `rage_and_dead_clicks`\n* `server_tree`\n* `text`\n* `agents_traces_table`" }, "interval": { "type": "string", "maxLength": 10 }, "queries": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "columns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "field_aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string" }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "is_hidden": { "type": "boolean" }, "on_demand_extraction": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "extraction_state": { "type": "string" }, "enabled": { "type": "boolean" } } }, "on_demand_extraction_disabled": { "type": "boolean" }, "selected_aggregate": { "type": "integer", "nullable": true }, "linked_dashboards": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "field": { "type": "string" }, "dashboard_id": { "type": "string" } }, "required": [ "dashboard_id", "field" ] }, "nullable": true } } } }, "widget_type": { "enum": [ "discover", "issue", "metrics", "error-events", "transaction-like", "spans", "logs", "tracemetrics", "preprod-app-size", null ], "type": "string", "description": "* `discover`\n* `issue`\n* `metrics`\n* `error-events`\n* `transaction-like`\n* `spans`\n* `logs`\n* `tracemetrics`\n* `preprod-app-size`", "nullable": true }, "limit": { "type": "integer", "minimum": 1, "nullable": true }, "layout": { "allOf": [ { "type": "object", "description": "Widget grid layout position and dimensions.\n\nThe dashboard uses a 6-column grid. Required keys: x, y, w, h, minH.\nConstraints: x (0-5), y (>= 0), w (1-6), h (>= 1), minH (>= 1), and x + w <= 6.", "properties": { "x": { "type": "integer", "maximum": 5, "minimum": 0, "description": "Column position (0-indexed)." }, "y": { "type": "integer", "minimum": 0, "description": "Row position (0-indexed)." }, "w": { "type": "integer", "maximum": 6, "minimum": 1, "description": "Width in grid columns (1-6)." }, "h": { "type": "integer", "minimum": 1, "description": "Height in grid rows." }, "min_h": { "type": "integer", "minimum": 1, "description": "Minimum height in grid rows." } }, "required": [ "h", "min_h", "w", "x", "y" ] } ], "nullable": true }, "axis_range": { "enum": [ "auto", "dataMin", null ], "type": "string", "description": "* `auto`\n* `dataMin`", "nullable": true }, "legend_type": { "enum": [ "default", "breakdown", null ], "type": "string", "description": "* `default`\n* `breakdown`", "nullable": true } } }, "description": "A json list of widgets saved in this dashboard." }, "projects": { "type": "array", "items": { "type": "integer" }, "description": "The saved projects filter for this dashboard." }, "environment": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The saved environment filter for this dashboard." }, "period": { "type": "string", "nullable": true, "description": "The saved time range period for this dashboard." }, "start": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved start time for this dashboard." }, "end": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved end time for this dashboard." }, "filters": { "type": "object", "additionalProperties": {}, "description": "The saved filters for this dashboard." }, "utc": { "type": "boolean", "description": "Setting that lets you display saved time range for this dashboard in UTC." }, "permissions": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "is_editable_by_everyone": { "type": "boolean", "description": "Whether the dashboard is editable by everyone." }, "teams_with_edit_access": { "type": "array", "items": { "type": "integer" }, "description": "List of team IDs that have edit access to a dashboard." } }, "required": [ "is_editable_by_everyone" ] } ], "nullable": true, "description": "Permissions that restrict users from editing dashboards" }, "is_favorited": { "type": "boolean", "default": false, "description": "Favorite the dashboard automatically for the request user" } }, "required": [ "title" ] }, "DashboardDetails": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string", "description": "A dashboard's unique id." }, "title": { "type": "string", "description": "The user-defined dashboard title.", "maxLength": 255 }, "widgets": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "thresholds": { "type": "object", "additionalProperties": {}, "nullable": true }, "display_type": { "enum": [ "line", "area", "bar", "table", "big_number", "details", "categorical_bar", "wheel", "rage_and_dead_clicks", "server_tree", "text", "agents_traces_table" ], "type": "string", "description": "* `line`\n* `area`\n* `bar`\n* `table`\n* `big_number`\n* `details`\n* `categorical_bar`\n* `wheel`\n* `rage_and_dead_clicks`\n* `server_tree`\n* `text`\n* `agents_traces_table`" }, "interval": { "type": "string", "maxLength": 10 }, "queries": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "columns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "field_aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string" }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "is_hidden": { "type": "boolean" }, "on_demand_extraction": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "extraction_state": { "type": "string" }, "enabled": { "type": "boolean" } } }, "on_demand_extraction_disabled": { "type": "boolean" }, "selected_aggregate": { "type": "integer", "nullable": true }, "linked_dashboards": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "field": { "type": "string" }, "dashboard_id": { "type": "string" } }, "required": [ "dashboard_id", "field" ] }, "nullable": true } } } }, "widget_type": { "enum": [ "discover", "issue", "metrics", "error-events", "transaction-like", "spans", "logs", "tracemetrics", "preprod-app-size", null ], "type": "string", "description": "* `discover`\n* `issue`\n* `metrics`\n* `error-events`\n* `transaction-like`\n* `spans`\n* `logs`\n* `tracemetrics`\n* `preprod-app-size`", "nullable": true }, "limit": { "type": "integer", "minimum": 1, "nullable": true }, "layout": { "allOf": [ { "type": "object", "description": "Widget grid layout position and dimensions.\n\nThe dashboard uses a 6-column grid. Required keys: x, y, w, h, minH.\nConstraints: x (0-5), y (>= 0), w (1-6), h (>= 1), minH (>= 1), and x + w <= 6.", "properties": { "x": { "type": "integer", "maximum": 5, "minimum": 0, "description": "Column position (0-indexed)." }, "y": { "type": "integer", "minimum": 0, "description": "Row position (0-indexed)." }, "w": { "type": "integer", "maximum": 6, "minimum": 1, "description": "Width in grid columns (1-6)." }, "h": { "type": "integer", "minimum": 1, "description": "Height in grid rows." }, "min_h": { "type": "integer", "minimum": 1, "description": "Minimum height in grid rows." } }, "required": [ "h", "min_h", "w", "x", "y" ] } ], "nullable": true }, "axis_range": { "enum": [ "auto", "dataMin", null ], "type": "string", "description": "* `auto`\n* `dataMin`", "nullable": true }, "legend_type": { "enum": [ "default", "breakdown", null ], "type": "string", "description": "* `default`\n* `breakdown`", "nullable": true } } }, "description": "A json list of widgets saved in this dashboard." }, "projects": { "type": "array", "items": { "type": "integer" }, "description": "The saved projects filter for this dashboard." }, "environment": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The saved environment filter for this dashboard." }, "period": { "type": "string", "nullable": true, "description": "The saved time range period for this dashboard." }, "start": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved start time for this dashboard." }, "end": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved end time for this dashboard." }, "filters": { "type": "object", "additionalProperties": {}, "description": "The saved filters for this dashboard." }, "utc": { "type": "boolean", "description": "Setting that lets you display saved time range for this dashboard in UTC." }, "permissions": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "is_editable_by_everyone": { "type": "boolean", "description": "Whether the dashboard is editable by everyone." }, "teams_with_edit_access": { "type": "array", "items": { "type": "integer" }, "description": "List of team IDs that have edit access to a dashboard." } }, "required": [ "is_editable_by_everyone" ] } ], "nullable": true, "description": "Permissions that restrict users from editing dashboards" } } }, "DashboardDetailsModel": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "period": { "type": "string" }, "utc": { "type": "string" }, "expired": { "type": "boolean" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "title": { "type": "string" }, "dateCreated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ], "nullable": true }, "widgets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "displayType": { "type": "string" }, "thresholds": { "type": "object", "properties": { "preferredPolarity": { "type": "string" }, "max_values": { "type": "object", "additionalProperties": { "type": "integer" } }, "unit": { "type": "string" } }, "required": [ "max_values", "unit" ], "nullable": true }, "interval": { "type": "string" }, "dateCreated": { "type": "string" }, "dashboardId": { "type": "string" }, "queries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "string" } }, "fieldAliases": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "widgetId": { "type": "string" }, "onDemand": { "type": "array", "items": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "extractionState": { "type": "string" }, "dashboardWidgetQueryId": { "type": "integer" } }, "required": [ "dashboardWidgetQueryId", "enabled", "extractionState" ] } }, "isHidden": { "type": "boolean" }, "selectedAggregate": { "type": "integer", "nullable": true }, "linkedDashboards": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "dashboardId": { "type": "integer" } }, "required": [ "dashboardId", "field" ] } } }, "required": [ "aggregates", "columns", "conditions", "fieldAliases", "fields", "id", "isHidden", "linkedDashboards", "name", "onDemand", "orderby", "selectedAggregate", "widgetId" ] } }, "limit": { "type": "integer", "nullable": true }, "widgetType": { "type": "string", "nullable": true }, "layout": { "type": "object", "additionalProperties": { "type": "integer" }, "nullable": true }, "axisRange": { "type": "string", "nullable": true }, "legendType": { "enum": [ "default", "breakdown" ], "type": "string", "nullable": true }, "datasetSource": { "type": "string", "nullable": true }, "exploreUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedReason": { "type": "array", "items": { "type": "object", "properties": { "orderby": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "equations": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "nullable": true }, "selected_columns": { "type": "array", "items": { "type": "string" } } }, "required": [ "equations", "orderby", "selected_columns" ] }, "nullable": true } }, "required": [ "axisRange", "changedReason", "dashboardId", "datasetSource", "dateCreated", "description", "displayType", "exploreUrls", "id", "interval", "layout", "legendType", "limit", "queries", "thresholds", "title", "widgetType" ] } }, "projects": { "type": "array", "items": { "type": "integer" } }, "filters": { "type": "object", "properties": { "release": { "type": "array", "items": { "type": "string" } }, "releaseId": { "type": "array", "items": { "type": "string" } }, "globalFilter": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "permissions": { "type": "object", "properties": { "isEditableByEveryone": { "type": "boolean" }, "teamsWithEditAccess": { "type": "array", "items": { "type": "integer" } } }, "required": [ "isEditableByEveryone", "teamsWithEditAccess" ], "nullable": true }, "isFavorited": { "type": "boolean" }, "prebuiltId": { "type": "integer", "nullable": true } }, "required": [ "createdBy", "dateCreated", "filters", "id", "isFavorited", "permissions", "prebuiltId", "projects", "title", "widgets" ] }, "DashboardListResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "dateCreated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "environment": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "properties": { "release": { "type": "array", "items": { "type": "string" } }, "releaseId": { "type": "array", "items": { "type": "string" } }, "globalFilter": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "lastVisited": { "type": "string", "nullable": true }, "widgetDisplay": { "type": "array", "items": { "type": "string" } }, "widgetPreview": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "permissions": { "type": "object", "properties": { "isEditableByEveryone": { "type": "boolean" }, "teamsWithEditAccess": { "type": "array", "items": { "type": "integer" } } }, "required": [ "isEditableByEveryone", "teamsWithEditAccess" ], "nullable": true }, "isFavorited": { "type": "boolean" }, "projects": { "type": "array", "items": { "type": "integer" } }, "prebuiltId": { "type": "integer", "nullable": true } }, "required": [ "createdBy", "dateCreated", "environment", "filters", "id", "isFavorited", "lastVisited", "permissions", "prebuiltId", "projects", "title", "widgetDisplay", "widgetPreview" ] } }, "DashboardPermissions": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "is_editable_by_everyone": { "type": "boolean", "description": "Whether the dashboard is editable by everyone." }, "teams_with_edit_access": { "type": "array", "items": { "type": "integer" }, "description": "List of team IDs that have edit access to a dashboard." } }, "required": [ "is_editable_by_everyone" ] }, "DashboardWidget": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "title": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "thresholds": { "type": "object", "additionalProperties": {}, "nullable": true }, "display_type": { "enum": [ "line", "area", "bar", "table", "big_number", "details", "categorical_bar", "wheel", "rage_and_dead_clicks", "server_tree", "text", "agents_traces_table" ], "type": "string", "description": "* `line`\n* `area`\n* `bar`\n* `table`\n* `big_number`\n* `details`\n* `categorical_bar`\n* `wheel`\n* `rage_and_dead_clicks`\n* `server_tree`\n* `text`\n* `agents_traces_table`" }, "interval": { "type": "string", "maxLength": 10 }, "queries": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "columns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "field_aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string" }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "is_hidden": { "type": "boolean" }, "on_demand_extraction": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "extraction_state": { "type": "string" }, "enabled": { "type": "boolean" } } }, "on_demand_extraction_disabled": { "type": "boolean" }, "selected_aggregate": { "type": "integer", "nullable": true }, "linked_dashboards": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "field": { "type": "string" }, "dashboard_id": { "type": "string" } }, "required": [ "dashboard_id", "field" ] }, "nullable": true } } } }, "widget_type": { "enum": [ "discover", "issue", "metrics", "error-events", "transaction-like", "spans", "logs", "tracemetrics", "preprod-app-size", null ], "type": "string", "description": "* `discover`\n* `issue`\n* `metrics`\n* `error-events`\n* `transaction-like`\n* `spans`\n* `logs`\n* `tracemetrics`\n* `preprod-app-size`", "nullable": true }, "limit": { "type": "integer", "minimum": 1, "nullable": true }, "layout": { "allOf": [ { "type": "object", "description": "Widget grid layout position and dimensions.\n\nThe dashboard uses a 6-column grid. Required keys: x, y, w, h, minH.\nConstraints: x (0-5), y (>= 0), w (1-6), h (>= 1), minH (>= 1), and x + w <= 6.", "properties": { "x": { "type": "integer", "maximum": 5, "minimum": 0, "description": "Column position (0-indexed)." }, "y": { "type": "integer", "minimum": 0, "description": "Row position (0-indexed)." }, "w": { "type": "integer", "maximum": 6, "minimum": 1, "description": "Width in grid columns (1-6)." }, "h": { "type": "integer", "minimum": 1, "description": "Height in grid rows." }, "min_h": { "type": "integer", "minimum": 1, "description": "Minimum height in grid rows." } }, "required": [ "h", "min_h", "w", "x", "y" ] } ], "nullable": true }, "axis_range": { "enum": [ "auto", "dataMin", null ], "type": "string", "description": "* `auto`\n* `dataMin`", "nullable": true }, "legend_type": { "enum": [ "default", "breakdown", null ], "type": "string", "description": "* `default`\n* `breakdown`", "nullable": true } } }, "DashboardWidgetQuery": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "aggregates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "columns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "field_aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "name": { "type": "string" }, "conditions": { "type": "string" }, "orderby": { "type": "string" }, "is_hidden": { "type": "boolean" }, "on_demand_extraction": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "extraction_state": { "type": "string" }, "enabled": { "type": "boolean" } } }, "on_demand_extraction_disabled": { "type": "boolean" }, "selected_aggregate": { "type": "integer", "nullable": true }, "linked_dashboards": { "type": "array", "items": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "field": { "type": "string" }, "dashboard_id": { "type": "string" } }, "required": [ "dashboard_id", "field" ] }, "nullable": true } } }, "DashboardWidgetQueryOnDemand": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "extraction_state": { "type": "string" }, "enabled": { "type": "boolean" } } }, "DataForwarder": { "type": "object", "properties": { "organization_id": { "type": "integer", "description": "The ID of the organization related to the data forwarder." }, "provider": { "enum": [ "segment", "sqs", "splunk" ], "type": "string", "description": "The provider of the data forwarder. One of \"segment\", \"sqs\", or \"splunk\".\n\n* `segment` - Segment\n* `sqs` - Amazon SQS\n* `splunk` - Splunk" }, "is_enabled": { "type": "boolean", "default": true, "description": "Whether the data forwarder is enabled." }, "enroll_new_projects": { "type": "boolean", "default": false, "description": "Whether to enroll new projects automatically, after they're created." }, "config": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The configuration for the data forwarder, specific to the provider type. \nFor a 'sqs' provider, the required keys are queue_url, region, access_key, secret_key. If using a FIFO queue, you must also provide a message_group_id, though s3_bucket is optional. \nFor a 'segment' provider, the required keys are write_key. \nFor a 'splunk' provider, the required keys are instance_url, index, source, token." }, "project_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the projects connected to the data forwarder. Missing project IDs will be unenrolled if previously enrolled." } }, "required": [ "organization_id", "provider" ] }, "DataForwarderResponse": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "isEnabled": { "type": "boolean" }, "enrollNewProjects": { "type": "boolean" }, "enrolledProjects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] } }, "provider": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "projectConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isEnabled": { "type": "boolean" }, "dataForwarderId": { "type": "string" }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] }, "overrides": { "type": "object", "additionalProperties": { "type": "string" } }, "effectiveConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "dataForwarderId", "dateAdded", "dateUpdated", "effectiveConfig", "id", "isEnabled", "overrides", "project" ] } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "config", "dateAdded", "dateUpdated", "enrollNewProjects", "enrolledProjects", "id", "isEnabled", "organizationId", "projectConfigs", "provider" ] }, "Deploy": { "type": "object", "properties": { "environment": { "type": "string", "description": "The environment you're deploying to", "maxLength": 64 }, "name": { "type": "string", "nullable": true, "description": "The optional name of the deploy", "maxLength": 64 }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The optional URL that points to the deploy" }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the deploy started" }, "dateFinished": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the deploy ended. If not provided, the current time is used." }, "projects": { "type": "array", "items": { "type": "string" }, "description": "The optional list of project slugs to create a deploy within. If not provided, deploys are created for all of the release's projects." } }, "required": [ "environment" ] }, "DeployResponse": { "type": "object", "description": "Serializer for Deploy response objects", "properties": { "id": { "type": "string", "description": "The ID of the deploy" }, "environment": { "type": "string", "description": "The environment name" }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the deploy started" }, "dateFinished": { "type": "string", "format": "date-time", "description": "An optional date that indicates when the deploy ended" }, "name": { "type": "string", "nullable": true, "description": "The optional name of the deploy" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The optional URL that points to the deploy" } }, "required": [ "dateFinished", "dateStarted", "environment", "id", "name", "url" ] }, "DetailedProject": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "digestsMinDelay": { "type": "integer" }, "digestsMaxDelay": { "type": "integer" }, "subjectPrefix": { "type": "string" }, "allowedDomains": { "type": "array", "items": { "type": "string" } }, "resolveAge": { "type": "integer" }, "dataScrubber": { "type": "boolean" }, "dataScrubberDefaults": { "type": "boolean" }, "safeFields": { "type": "array", "items": { "type": "string" } }, "storeCrashReports": { "type": "integer", "nullable": true }, "sensitiveFields": { "type": "array", "items": { "type": "string" } }, "subjectTemplate": { "type": "string" }, "securityToken": { "type": "string" }, "securityTokenHeader": { "type": "string", "nullable": true }, "verifySSL": { "type": "boolean" }, "scrubIPAddresses": { "type": "boolean" }, "scrapeJavaScript": { "type": "boolean" }, "highlightTags": { "type": "array", "items": { "type": "string" } }, "highlightContext": { "type": "object", "additionalProperties": {} }, "highlightPreset": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "context": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "context", "tags" ] }, "groupingConfig": { "type": "string" }, "derivedGroupingEnhancements": { "type": "string" }, "groupingEnhancements": { "type": "string" }, "secondaryGroupingExpiry": { "type": "integer" }, "secondaryGroupingConfig": { "type": "string", "nullable": true }, "fingerprintingRules": { "type": "string" }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "plugins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "shortName": { "type": "string" }, "type": { "type": "string" }, "canDisable": { "type": "boolean" }, "isTestable": { "type": "boolean" }, "hasConfiguration": { "type": "boolean" }, "metadata": { "type": "object", "additionalProperties": {} }, "contexts": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "assets": { "type": "array", "items": {} }, "doc": { "type": "string" }, "firstPartyAlternative": {}, "deprecationDate": {}, "altIsSentryApp": {}, "enabled": { "type": "boolean" }, "version": { "type": "string" }, "author": { "type": "object", "additionalProperties": { "type": "string" } }, "isDeprecated": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "featureDescriptions": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "resourceLinks": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } }, "required": [ "altIsSentryApp", "assets", "author", "canDisable", "contexts", "deprecationDate", "description", "doc", "enabled", "featureDescriptions", "features", "firstPartyAlternative", "hasConfiguration", "id", "isDeprecated", "isHidden", "isTestable", "metadata", "name", "resourceLinks", "shortName", "slug", "status", "type", "version" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "processingIssues": { "type": "integer" }, "defaultEnvironment": { "type": "string", "nullable": true }, "relayPiiConfig": { "type": "string", "nullable": true }, "builtinSymbolSources": { "type": "array", "items": { "type": "string" } }, "dynamicSamplingBiases": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] } } }, "symbolSources": { "type": "string" }, "isDynamicallySampled": { "type": "boolean" }, "tempestFetchScreenshots": { "type": "boolean" }, "autofixAutomationTuning": { "type": "string" }, "seerScannerAutomation": { "type": "boolean" }, "seerNightshiftTweaks": {}, "scmSourceContextEnabled": { "type": "boolean" }, "debugFilesRole": { "type": "string", "nullable": true } }, "required": [ "access", "allowedDomains", "autofixAutomationTuning", "avatar", "builtinSymbolSources", "color", "dataScrubber", "dataScrubberDefaults", "dateCreated", "debugFilesRole", "defaultEnvironment", "derivedGroupingEnhancements", "digestsMaxDelay", "digestsMinDelay", "dynamicSamplingBiases", "features", "fingerprintingRules", "firstEvent", "firstTransactionEvent", "groupingConfig", "groupingEnhancements", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "highlightContext", "highlightPreset", "highlightTags", "id", "isBookmarked", "isDynamicallySampled", "isInternal", "isMember", "isPublic", "latestRelease", "name", "options", "organization", "platform", "platforms", "plugins", "processingIssues", "relayPiiConfig", "resolveAge", "safeFields", "scmSourceContextEnabled", "scrapeJavaScript", "scrubIPAddresses", "secondaryGroupingConfig", "secondaryGroupingExpiry", "securityToken", "securityTokenHeader", "seerNightshiftTweaks", "seerScannerAutomation", "sensitiveFields", "slug", "status", "storeCrashReports", "subjectPrefix", "subjectTemplate", "symbolSources", "teams", "tempestFetchScreenshots", "verifySSL" ] }, "Detector": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ], "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "latestGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "workflowIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dataSources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true }, "conditionGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "enabled": { "type": "boolean" }, "openIssues": { "type": "integer" } }, "required": [ "conditionGroup", "config", "dataSources", "dateCreated", "dateUpdated", "enabled", "id", "name", "openIssues", "projectId", "type", "workflowIds" ] }, "DiscoverSavedQuery": { "type": "object", "properties": { "name": { "type": "string", "description": "The user-defined saved query name.", "maxLength": 255 }, "projects": { "type": "array", "items": { "type": "integer" }, "description": "The saved projects filter for this query." }, "queryDataset": { "enum": [ "discover", "error-events", "transaction-like" ], "type": "string", "default": "error-events", "description": "The dataset you would like to query. Note: `discover` is a **deprecated** value. The allowed values are: `error-events`, `transaction-like`\n\n* `discover`\n* `error-events`\n* `transaction-like`" }, "start": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved start time for this saved query." }, "end": { "type": "string", "format": "date-time", "nullable": true, "description": "The saved end time for this saved query." }, "range": { "type": "string", "nullable": true, "description": "The saved time range period for this saved query." }, "fields": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The fields, functions, or equations that can be requested for the query. At most 20 fields can be selected per request. Each field can be one of the following types:\n- A built-in key field. See possible fields in the [properties table](/product/sentry-basics/search/searchable-properties/#properties-table), under any field that is an event property.\n - example: `field=transaction`\n- A tag. Tags should use the `tag[]` formatting to avoid ambiguity with any fields\n - example: `field=tag[isEnterprise]`\n- A function which will be in the format of `function_name(parameters,...)`. See possible functions in the [query builder documentation](/product/discover-queries/query-builder/#stacking-functions).\n - when a function is included, Discover will group by any tags or fields\n - example: `field=count_if(transaction.duration,greater,300)`\n- An equation when prefixed with `equation|`. Read more about [equations here](/product/discover-queries/query-builder/query-equations/).\n - example: `field=equation|count_if(transaction.duration,greater,300) / count() * 100`\n" }, "orderby": { "type": "string", "nullable": true, "description": "How to order the query results. Must be something in the `field` list, excluding equations." }, "environment": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The name of environments to filter by." }, "query": { "type": "string", "nullable": true, "description": "Filters results by using [query syntax](/product/sentry-basics/search/)." }, "yAxis": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Aggregate functions to be plotted on the chart." }, "display": { "type": "string", "nullable": true, "description": "Visualization type for saved query chart. Allowed values are:\n- default\n- previous\n- top5\n- daily\n- dailytop5\n- bar\n" }, "topEvents": { "type": "integer", "maximum": 10, "minimum": 1, "nullable": true, "description": "Number of top events' timeseries to be visualized." }, "interval": { "type": "string", "nullable": true, "description": "Resolution of the time series." } }, "required": [ "name" ] }, "DiscoverSavedQueryListResponse": { "type": "array", "items": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "widths": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "array", "items": { "type": "string" } }, "aggregations": { "type": "array", "items": { "type": "string" } }, "range": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "orderby": { "type": "string" }, "limit": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "display": { "type": "string" }, "topEvents": { "type": "integer" }, "interval": { "type": "string" }, "exploreQuery": { "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "integer" } }, "version": { "type": "integer" }, "queryDataset": { "type": "string" }, "datasetSource": { "type": "string" }, "expired": { "type": "boolean" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] } }, "required": [ "createdBy", "datasetSource", "dateCreated", "dateUpdated", "expired", "id", "name", "projects", "queryDataset", "version" ] } }, "DiscoverSavedQueryModel": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "widths": { "type": "array", "items": { "type": "string" } }, "conditions": { "type": "array", "items": { "type": "string" } }, "aggregations": { "type": "array", "items": { "type": "string" } }, "range": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "orderby": { "type": "string" }, "limit": { "type": "string" }, "yAxis": { "type": "array", "items": { "type": "string" } }, "display": { "type": "string" }, "topEvents": { "type": "integer" }, "interval": { "type": "string" }, "exploreQuery": { "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "integer" } }, "version": { "type": "integer" }, "queryDataset": { "type": "string" }, "datasetSource": { "type": "string" }, "expired": { "type": "boolean" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "createdBy": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] } }, "required": [ "createdBy", "datasetSource", "dateCreated", "dateUpdated", "expired", "id", "name", "projects", "queryDataset", "version" ] }, "DynamicSdkLoaderOption": { "type": "object", "description": "Configures multiple options for the Javascript Loader Script.\n- `Performance Monitoring`\n- `Debug Bundles & Logging`\n- `Session Replay` - Note that the loader will load the ES6 bundle instead of the ES5 bundle.\n- `User Feedback` - Note that the loader will load the ES6 bundle instead of the ES5 bundle.\n- `Logs and Metrics` - Note that the loader will load the ES6 bundle instead of the ES5 bundle. Requires SDK >= 10.0.0.\n```json\n{\n \"dynamicSdkLoaderOptions\": {\n \"hasReplay\": true,\n \"hasPerformance\": true,\n \"hasDebug\": true,\n \"hasFeedback\": true,\n \"hasLogsAndMetrics\": true\n }\n}\n```", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } } }, "Environment": { "type": "object", "properties": { "isHidden": { "type": "boolean", "description": "Specify `true` to make the environment visible or `false` to make the environment hidden." } }, "required": [ "isHidden" ] }, "EnvironmentProject": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isHidden": { "type": "boolean" } }, "required": [ "id", "isHidden", "name" ] }, "EventIdLookupResponse": { "type": "object", "properties": { "organizationSlug": { "type": "string" }, "projectSlug": { "type": "string" }, "groupId": { "type": "string" }, "eventId": { "type": "string" }, "event": { "type": "object", "properties": { "id": { "type": "string" }, "groupID": { "type": "string", "nullable": true }, "eventID": { "type": "string" }, "projectID": { "type": "string" }, "message": { "type": "string", "nullable": true }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "geo": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "nullable": true }, "tags": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "platform": { "type": "string" }, "dateReceived": { "type": "string", "format": "date-time", "nullable": true }, "contexts": { "type": "object", "additionalProperties": {}, "nullable": true }, "size": { "type": "integer", "nullable": true }, "entries": { "type": "array", "items": {} }, "dist": { "type": "string", "nullable": true }, "sdk": { "type": "object", "additionalProperties": { "type": "string" } }, "context": { "type": "object", "additionalProperties": {}, "nullable": true }, "packages": { "type": "object", "additionalProperties": {} }, "type": { "type": "string" }, "metadata": {}, "errors": { "type": "array", "items": {} }, "occurrence": {}, "_meta": { "type": "object", "additionalProperties": {} }, "crashFile": { "type": "string", "nullable": true }, "culprit": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "fingerprints": { "type": "array", "items": { "type": "string" } }, "groupingConfig": {}, "startTimestamp": { "type": "string", "format": "date-time" }, "endTimestamp": { "type": "string", "format": "date-time" }, "measurements": {}, "breakdowns": {} }, "required": [ "_meta", "context", "contexts", "dateReceived", "dist", "entries", "errors", "eventID", "groupID", "id", "location", "message", "metadata", "occurrence", "packages", "platform", "projectID", "sdk", "size", "tags", "title", "type", "user" ] } }, "required": [ "event", "eventId", "groupId", "organizationSlug", "projectSlug" ] }, "ExternalActor": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] }, "ExternalTeam": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "external_name": { "type": "string", "description": "The associated name for the provider." }, "provider": { "enum": [ "github", "github_enterprise", "jira_server", "slack", "slack_staging", "perforce", "gitlab", "msteams", "custom_scm" ], "type": "string", "description": "The provider of the external actor.\n\n* `github`\n* `github_enterprise`\n* `jira_server`\n* `slack`\n* `slack_staging`\n* `perforce`\n* `gitlab`\n* `msteams`\n* `custom_scm`" }, "integration_id": { "type": "integer", "description": "The Integration ID." }, "external_id": { "type": "string", "nullable": true, "description": "The associated user ID for provider." } }, "required": [ "external_name", "integration_id", "provider" ] }, "ExternalUser": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "user_id": { "type": "integer", "description": "The user ID in Sentry." }, "external_name": { "type": "string", "description": "The associated name for the provider." }, "provider": { "enum": [ "github", "github_enterprise", "jira_server", "slack", "slack_staging", "perforce", "gitlab", "msteams", "custom_scm" ], "type": "string", "description": "The provider of the external actor.\n\n* `github`\n* `github_enterprise`\n* `jira_server`\n* `slack`\n* `slack_staging`\n* `perforce`\n* `gitlab`\n* `msteams`\n* `custom_scm`" }, "integration_id": { "type": "integer", "description": "The Integration ID." }, "id": { "type": "integer", "readOnly": true, "description": "The external actor ID." }, "external_id": { "type": "string", "nullable": true, "description": "The associated user ID for provider." } }, "required": [ "external_name", "id", "integration_id", "provider", "user_id" ] }, "Filters": { "type": "object", "description": "Filter settings for the source. This is optional for all sources.\n\n**`filetypes`** ***(list)*** - A list of file types that can be found on this source. If this is left empty, all file types will be enabled. The options are:\n- `pe` - Windows executable files\n- `pdb` - Windows debug files\n- `portablepdb` - .NET portable debug files\n- `mach_code` - MacOS executable files\n- `mach_debug` - MacOS debug files\n- `elf_code` - ELF executable files\n- `elf_debug` - ELF debug files\n- `wasm_code` - WASM executable files\n- `wasm_debug` - WASM debug files\n- `breakpad` - Breakpad symbol files\n- `sourcebundle` - Source code bundles\n- `uuidmap` - Apple UUID mapping files\n- `bcsymbolmap` - Apple bitcode symbol maps\n- `il2cpp` - Unity IL2CPP mapping files\n- `proguard` - ProGuard mapping files\n\n**`path_patterns`** ***(list)*** - A list of glob patterns to check against the debug and code file paths of debug files. Only files that match one of these patterns will be requested from the source. If this is left empty, no path-based filtering takes place.\n\n**`requires_checksum`** ***(boolean)*** - Whether this source requires a debug checksum to be sent with each request. Defaults to `false`.\n\n```json\n{\n \"filters\": {\n \"filetypes\": [\"pe\", \"pdb\", \"portablepdb\"],\n \"path_patterns\": [\"*ffmpeg*\"]\n }\n}\n```", "properties": { "filetypes": { "type": "array", "items": { "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ], "type": "string", "description": "* `pe`\n* `pdb`\n* `portablepdb`\n* `mach_debug`\n* `mach_code`\n* `elf_debug`\n* `elf_code`\n* `wasm_debug`\n* `wasm_code`\n* `breakpad`\n* `sourcebundle`\n* `uuidmap`\n* `bcsymbolmap`\n* `il2cpp`\n* `proguard`\n* `dartsymbolmap`" }, "description": "The file types enabled for the source." }, "path_patterns": { "type": "array", "items": { "type": "string" }, "description": "The debug and code file paths enabled for the source." }, "requires_checksum": { "type": "boolean", "description": "Whether the source requires debug checksums." } } }, "GetReplay": { "type": "object", "properties": { "id": { "type": "string" }, "project_id": { "type": "string" }, "trace_ids": { "type": "array", "items": { "type": "string" } }, "error_ids": { "type": "array", "items": { "type": "string" } }, "environment": { "type": "string", "nullable": true }, "tags": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": {} } ] }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "geo": { "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "subdivision": { "type": "string", "nullable": true } } } } }, "sdk": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "os": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "browser": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "device": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "family": { "type": "string", "nullable": true } } }, "ota_updates": { "type": "object", "properties": { "channel": { "type": "string", "nullable": true }, "runtime_version": { "type": "string", "nullable": true }, "update_id": { "type": "string", "nullable": true } } }, "is_archived": { "type": "boolean", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "clicks": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "count_dead_clicks": { "type": "integer", "nullable": true }, "count_rage_clicks": { "type": "integer", "nullable": true }, "count_errors": { "type": "integer", "nullable": true }, "duration": { "type": "integer", "nullable": true }, "finished_at": { "type": "string", "nullable": true }, "started_at": { "type": "string", "nullable": true }, "activity": { "type": "integer", "nullable": true }, "count_urls": { "type": "integer", "nullable": true }, "replay_type": { "type": "string" }, "count_segments": { "type": "integer", "nullable": true }, "platform": { "type": "string", "nullable": true }, "releases": { "type": "array", "items": { "type": "string" } }, "dist": { "type": "string", "nullable": true }, "count_warnings": { "type": "integer", "nullable": true }, "count_infos": { "type": "integer", "nullable": true }, "has_viewed": { "type": "boolean" } } }, "GetReplayDeletionJob": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "rangeStart": { "type": "string" }, "rangeEnd": { "type": "string" }, "environments": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "query": { "type": "string" }, "countDeleted": { "type": "integer" } }, "required": [ "countDeleted", "dateCreated", "dateUpdated", "environments", "id", "query", "rangeEnd", "rangeStart", "status" ] } }, "required": [ "data" ] }, "GetReplayRecordingSegment": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "GetReplayViewedBy": { "type": "object", "properties": { "data": { "type": "object", "properties": { "viewed_by": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "viewed_by" ] } }, "required": [ "data" ] }, "GroupEventsResponseDict": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "event.type": { "type": "string" }, "groupID": { "type": "string", "nullable": true }, "eventID": { "type": "string" }, "projectID": { "type": "string" }, "message": { "type": "string" }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "culprit": { "type": "string", "nullable": true }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "geo": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "nullable": true }, "tags": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "crashFile": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "crashFile", "culprit", "dateCreated", "event.type", "eventID", "groupID", "id", "location", "message", "metadata", "platform", "projectID", "tags", "title", "user" ] } }, "GroupExternalIssueResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "issueId": { "type": "string" }, "serviceType": { "type": "string" }, "displayName": { "type": "string" }, "webUrl": { "type": "string" } }, "required": [ "displayName", "id", "issueId", "serviceType", "webUrl" ] } }, "GroupValidator": { "type": "object", "properties": { "inbox": { "type": "boolean", "description": "If true, marks the issue as reviewed by the requestor." }, "status": { "enum": [ "resolved", "unresolved", "ignored", "resolvedInNextRelease", "muted" ], "type": "string", "description": "Limit mutations to only issues with the given status.\n\n* `resolved`\n* `unresolved`\n* `ignored`\n* `resolvedInNextRelease`\n* `muted`" }, "statusDetails": { "allOf": [ { "type": "object", "properties": { "inNextRelease": { "type": "boolean", "description": "If true, marks the issue as resolved in the next release." }, "inRelease": { "type": "string", "description": "The version of the release that the issue should be resolved in.If set to `latest`, the latest release will be used." }, "inCommit": { "allOf": [ { "type": "object", "properties": { "commit": { "type": "string", "description": "The SHA of the resolving commit." }, "repository": { "type": "string", "description": "The name of the repository (as it appears in Sentry)." } }, "required": [ "commit", "repository" ] } ], "description": "The commit data that the issue should use for resolution." }, "ignoreDuration": { "type": "integer", "description": "Ignore the issue until for this many minutes." }, "ignoreCount": { "type": "integer", "description": "Ignore the issue until it has occurred this many times in `ignoreWindow` minutes." }, "ignoreWindow": { "type": "integer", "maximum": 10080, "description": "Ignore the issue until it has occurred `ignoreCount` times in this many minutes. (Max: 1 week)" }, "ignoreUserCount": { "type": "integer", "description": "Ignore the issue until it has affected this many users in `ignoreUserWindow` minutes." }, "ignoreUserWindow": { "type": "integer", "maximum": 10080, "description": "Ignore the issue until it has affected `ignoreUserCount` users in this many minutes. (Max: 1 week)" } }, "required": [ "ignoreCount", "ignoreDuration", "ignoreUserCount", "ignoreUserWindow", "ignoreWindow", "inNextRelease", "inRelease" ] } ], "description": "Additional details about the resolution. Status detail updates that include release data are only allowed for issues within a single project." }, "substatus": { "enum": [ "archived_until_escalating", "archived_until_condition_met", "archived_forever", "escalating", "ongoing", "regressed", "new", null ], "type": "string", "nullable": true, "description": "The new substatus of the issue.\n\n* `archived_until_escalating`\n* `archived_until_condition_met`\n* `archived_forever`\n* `escalating`\n* `ongoing`\n* `regressed`\n* `new`" }, "hasSeen": { "type": "boolean", "description": "If true, marks the issue as seen by the requestor." }, "isBookmarked": { "type": "boolean", "description": "If true, bookmarks the issue for the requestor." }, "isPublic": { "type": "boolean", "description": "If true, publishes the issue." }, "isSubscribed": { "type": "boolean", "description": "If true, subscribes the requestor to the issue." }, "merge": { "type": "boolean", "description": "If true, merges the issues together." }, "discard": { "type": "boolean", "description": "If true, discards the issues instead of updating them." }, "assignedTo": { "type": "string", "description": "The user or team that should be assigned to the issues. Values take the form of ``, `user:`, ``, ``, or `team:`." }, "priority": { "enum": [ "low", "medium", "high" ], "type": "string", "description": "The priority that should be set for the issues\n\n* `low`\n* `medium`\n* `high`" } }, "required": [ "assignedTo", "discard", "hasSeen", "inbox", "isBookmarked", "isPublic", "isSubscribed", "merge", "priority", "status", "statusDetails", "substatus" ] }, "InCommitValidator": { "type": "object", "properties": { "commit": { "type": "string", "description": "The SHA of the resolving commit." }, "repository": { "type": "string", "description": "The name of the repository (as it appears in Sentry)." } }, "required": [ "commit", "repository" ] }, "InstallInfoResponse": { "type": "object", "properties": { "buildId": { "type": "string" }, "state": { "type": "string" }, "appInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ] }, "gitInfo": { "type": "object", "properties": { "headSha": { "type": "string", "nullable": true }, "baseSha": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "headRepoName": { "type": "string", "nullable": true }, "baseRepoName": { "type": "string", "nullable": true }, "headRef": { "type": "string", "nullable": true }, "baseRef": { "type": "string", "nullable": true }, "prNumber": { "type": "integer", "nullable": true } }, "required": [ "baseRef", "baseRepoName", "baseSha", "headRef", "headRepoName", "headSha", "prNumber", "provider" ], "nullable": true }, "platform": { "type": "string", "nullable": true }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "buildConfiguration": { "type": "string", "nullable": true }, "isInstallable": { "type": "boolean" }, "installUrl": { "type": "string", "nullable": true }, "installUrlExpiresAt": { "type": "string", "nullable": true }, "downloadCount": { "type": "integer" }, "releaseNotes": { "type": "string", "nullable": true }, "installGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isCodeSignatureValid": { "type": "boolean", "nullable": true }, "profileName": { "type": "string", "nullable": true }, "codesigningType": { "type": "string", "nullable": true } }, "required": [ "appInfo", "buildConfiguration", "buildId", "codesigningType", "downloadCount", "gitInfo", "installGroups", "installUrl", "installUrlExpiresAt", "isCodeSignatureValid", "isInstallable", "platform", "profileName", "projectId", "projectSlug", "releaseNotes", "state" ] }, "IssueEventDetailsResponse": { "type": "object", "properties": { "id": { "type": "string" }, "groupID": { "type": "string", "nullable": true }, "eventID": { "type": "string" }, "projectID": { "type": "string" }, "message": { "type": "string", "nullable": true }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "geo": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "nullable": true }, "tags": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "platform": { "type": "string" }, "dateReceived": { "type": "string", "format": "date-time", "nullable": true }, "contexts": { "type": "object", "additionalProperties": {}, "nullable": true }, "size": { "type": "integer", "nullable": true }, "entries": { "type": "array", "items": {} }, "dist": { "type": "string", "nullable": true }, "sdk": { "type": "object", "additionalProperties": { "type": "string" } }, "context": { "type": "object", "additionalProperties": {}, "nullable": true }, "packages": { "type": "object", "additionalProperties": {} }, "type": { "type": "string" }, "metadata": {}, "errors": { "type": "array", "items": {} }, "occurrence": {}, "_meta": { "type": "object", "additionalProperties": {} }, "crashFile": { "type": "string", "nullable": true }, "culprit": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "fingerprints": { "type": "array", "items": { "type": "string" } }, "groupingConfig": {}, "startTimestamp": { "type": "string", "format": "date-time" }, "endTimestamp": { "type": "string", "format": "date-time" }, "measurements": {}, "breakdowns": {}, "release": { "type": "object", "properties": { "id": { "type": "integer" }, "commitCount": { "type": "integer" }, "data": { "type": "object", "additionalProperties": {} }, "dateCreated": { "type": "string", "format": "date-time" }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "deployCount": { "type": "integer" }, "ref": { "type": "string", "nullable": true }, "lastCommit": { "type": "object", "additionalProperties": {}, "nullable": true }, "lastDeploy": { "type": "object", "properties": { "dateStarted": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "id": { "type": "string" }, "environment": { "type": "string" }, "dateFinished": { "type": "string" }, "name": { "type": "string" } }, "required": [ "dateFinished", "environment", "id", "name" ], "nullable": true }, "status": { "type": "string" }, "url": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "versionInfo": { "type": "object", "properties": { "description": { "type": "string" }, "package": { "type": "string", "nullable": true }, "version": { "type": "object", "additionalProperties": {} }, "buildHash": { "type": "string", "nullable": true } }, "required": [ "buildHash", "package", "version" ], "nullable": true } }, "nullable": true }, "userReport": { "type": "object", "properties": { "id": { "type": "string" }, "eventID": { "type": "string" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "comments": { "type": "string" }, "dateCreated": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } }, "required": [ "avatarUrl", "email", "id", "ipAddress", "name", "username" ], "nullable": true }, "event": { "type": "object", "properties": { "id": { "type": "string" }, "eventID": { "type": "string" } }, "required": [ "eventID", "id" ] } }, "required": [ "comments", "dateCreated", "email", "event", "eventID", "id", "name", "user" ], "nullable": true }, "sdkUpdates": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "resolvedWith": { "type": "array", "items": { "type": "string" } }, "nextEventID": { "type": "string", "nullable": true }, "previousEventID": { "type": "string", "nullable": true } }, "required": [ "_meta", "context", "contexts", "dateReceived", "dist", "entries", "errors", "eventID", "groupID", "id", "location", "message", "metadata", "nextEventID", "occurrence", "packages", "platform", "previousEventID", "projectID", "release", "resolvedWith", "sdk", "sdkUpdates", "size", "tags", "title", "type", "user", "userReport" ] }, "LatestInstallableBuildResponse": { "type": "object", "properties": { "latestArtifact": { "type": "object", "properties": { "buildId": { "type": "string" }, "state": { "type": "string" }, "appInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ] }, "gitInfo": { "type": "object", "properties": { "headSha": { "type": "string", "nullable": true }, "baseSha": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "headRepoName": { "type": "string", "nullable": true }, "baseRepoName": { "type": "string", "nullable": true }, "headRef": { "type": "string", "nullable": true }, "baseRef": { "type": "string", "nullable": true }, "prNumber": { "type": "integer", "nullable": true } }, "required": [ "baseRef", "baseRepoName", "baseSha", "headRef", "headRepoName", "headSha", "prNumber", "provider" ], "nullable": true }, "platform": { "type": "string", "nullable": true }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "buildConfiguration": { "type": "string", "nullable": true }, "isInstallable": { "type": "boolean" }, "installUrl": { "type": "string", "nullable": true }, "installUrlExpiresAt": { "type": "string", "nullable": true }, "downloadCount": { "type": "integer" }, "releaseNotes": { "type": "string", "nullable": true }, "installGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isCodeSignatureValid": { "type": "boolean", "nullable": true }, "profileName": { "type": "string", "nullable": true }, "codesigningType": { "type": "string", "nullable": true } }, "required": [ "appInfo", "buildConfiguration", "buildId", "codesigningType", "downloadCount", "gitInfo", "installGroups", "installUrl", "installUrlExpiresAt", "isCodeSignatureValid", "isInstallable", "platform", "profileName", "projectId", "projectSlug", "releaseNotes", "state" ], "nullable": true }, "currentArtifact": { "type": "object", "properties": { "buildId": { "type": "string" }, "state": { "type": "string" }, "appInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ] }, "gitInfo": { "type": "object", "properties": { "headSha": { "type": "string", "nullable": true }, "baseSha": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "headRepoName": { "type": "string", "nullable": true }, "baseRepoName": { "type": "string", "nullable": true }, "headRef": { "type": "string", "nullable": true }, "baseRef": { "type": "string", "nullable": true }, "prNumber": { "type": "integer", "nullable": true } }, "required": [ "baseRef", "baseRepoName", "baseSha", "headRef", "headRepoName", "headSha", "prNumber", "provider" ], "nullable": true }, "platform": { "type": "string", "nullable": true }, "projectId": { "type": "string" }, "projectSlug": { "type": "string" }, "buildConfiguration": { "type": "string", "nullable": true }, "isInstallable": { "type": "boolean" }, "installUrl": { "type": "string", "nullable": true }, "installUrlExpiresAt": { "type": "string", "nullable": true }, "downloadCount": { "type": "integer" }, "releaseNotes": { "type": "string", "nullable": true }, "installGroups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isCodeSignatureValid": { "type": "boolean", "nullable": true }, "profileName": { "type": "string", "nullable": true }, "codesigningType": { "type": "string", "nullable": true } }, "required": [ "appInfo", "buildConfiguration", "buildId", "codesigningType", "downloadCount", "gitInfo", "installGroups", "installUrl", "installUrlExpiresAt", "isCodeSignatureValid", "isInstallable", "platform", "profileName", "projectId", "projectSlug", "releaseNotes", "state" ], "nullable": true } }, "required": [ "currentArtifact", "latestArtifact" ] }, "Layout": { "type": "object", "description": "Layout settings for the source. This is required for HTTP, GCS, and S3 sources.\n\n**`type`** ***(string)*** - The layout of the folder structure. The options are:\n- `native` - Platform-Specific (SymStore / GDB / LLVM)\n- `symstore` - Microsoft SymStore\n- `symstore_index2` - Microsoft SymStore (with index2.txt)\n- `ssqp` - Microsoft SSQP\n- `unified` - Unified Symbol Server Layout\n- `debuginfod` - debuginfod\n\n**`casing`** ***(string)*** - The layout of the folder structure. The options are:\n- `default` - Default (mixed case)\n- `uppercase` - Uppercase\n- `lowercase` - Lowercase\n\n```json\n{\n \"layout\": {\n \"type\": \"native\"\n \"casing\": \"default\"\n }\n}\n```", "properties": { "type": { "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ], "type": "string", "description": "The source's layout type.\n\n* `native`\n* `symstore`\n* `symstore_index2`\n* `ssqp`\n* `unified`\n* `debuginfod`\n* `slashsymbols`" }, "casing": { "enum": [ "lowercase", "uppercase", "default" ], "type": "string", "description": "The source's casing rules.\n\n* `lowercase`\n* `uppercase`\n* `default`" } }, "required": [ "casing", "type" ] }, "LinkedDashboard": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "field": { "type": "string" }, "dashboard_id": { "type": "string" } }, "required": [ "dashboard_id", "field" ] }, "ListClientKeysResponse": { "type": "array", "items": { "type": "object", "description": "This represents a Sentry Project Client Key.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "public": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "projectId": { "type": "integer" }, "isActive": { "type": "boolean" }, "rateLimit": { "type": "object", "properties": { "window": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "count", "window" ], "nullable": true }, "dsn": { "type": "object", "properties": { "secret": { "type": "string" }, "public": { "type": "string" }, "csp": { "type": "string" }, "security": { "type": "string" }, "minidump": { "type": "string" }, "nel": { "type": "string" }, "unreal": { "type": "string" }, "crons": { "type": "string" }, "cdn": { "type": "string" }, "playstation": { "type": "string" }, "integration": { "type": "string" }, "otlp_traces": { "type": "string" }, "otlp_logs": { "type": "string" } }, "required": [ "cdn", "crons", "csp", "integration", "minidump", "nel", "otlp_logs", "otlp_traces", "playstation", "public", "secret", "security", "unreal" ] }, "browserSdkVersion": { "type": "string" }, "browserSdk": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "choices" ] }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dynamicSdkLoaderOptions": { "type": "object", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } }, "required": [ "hasDebug", "hasFeedback", "hasLogsAndMetrics", "hasPerformance", "hasReplay" ] }, "useCase": { "type": "string" } }, "required": [ "browserSdk", "browserSdkVersion", "dateCreated", "dsn", "dynamicSdkLoaderOptions", "id", "isActive", "label", "name", "projectId", "public", "rateLimit", "secret" ] } }, "ListDataForwarderResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "isEnabled": { "type": "boolean" }, "enrollNewProjects": { "type": "boolean" }, "enrolledProjects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] } }, "provider": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "projectConfigs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isEnabled": { "type": "boolean" }, "dataForwarderId": { "type": "string" }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "platform", "slug" ] }, "overrides": { "type": "object", "additionalProperties": { "type": "string" } }, "effectiveConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "dataForwarderId", "dateAdded", "dateUpdated", "effectiveConfig", "id", "isEnabled", "overrides", "project" ] } }, "dateAdded": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "config", "dateAdded", "dateUpdated", "enrollNewProjects", "enrolledProjects", "id", "isEnabled", "organizationId", "projectConfigs", "provider" ] } }, "ListDetectorSerializerResponse": { "type": "array", "items": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ], "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "latestGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "workflowIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "dataSources": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true }, "conditionGroup": { "type": "object", "additionalProperties": {}, "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "enabled": { "type": "boolean" }, "openIssues": { "type": "integer" } }, "required": [ "conditionGroup", "config", "dataSources", "dateCreated", "dateUpdated", "enabled", "id", "name", "openIssues", "projectId", "type", "workflowIds" ] } }, "ListMemberOnTeamResponse": { "type": "array", "items": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "role": { "type": "string" }, "roleName": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true }, "teamRole": { "type": "string", "nullable": true }, "teamSlug": { "type": "string" } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "inviterName", "name", "orgRole", "pending", "teamRole", "teamSlug", "user" ] } }, "ListOrgMembersResponse": { "type": "array", "items": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "inviterName", "name", "orgRole", "pending" ] } }, "ListOrgTeamResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] } }, "ListOrganizationClientKeysResponse": { "type": "array", "items": { "type": "object", "description": "This represents a Sentry Project Client Key.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "public": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "projectId": { "type": "integer" }, "isActive": { "type": "boolean" }, "rateLimit": { "type": "object", "properties": { "window": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "count", "window" ], "nullable": true }, "dsn": { "type": "object", "properties": { "secret": { "type": "string" }, "public": { "type": "string" }, "csp": { "type": "string" }, "security": { "type": "string" }, "minidump": { "type": "string" }, "nel": { "type": "string" }, "unreal": { "type": "string" }, "crons": { "type": "string" }, "cdn": { "type": "string" }, "playstation": { "type": "string" }, "integration": { "type": "string" }, "otlp_traces": { "type": "string" }, "otlp_logs": { "type": "string" } }, "required": [ "cdn", "crons", "csp", "integration", "minidump", "nel", "otlp_logs", "otlp_traces", "playstation", "public", "secret", "security", "unreal" ] }, "browserSdkVersion": { "type": "string" }, "browserSdk": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "choices" ] }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dynamicSdkLoaderOptions": { "type": "object", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } }, "required": [ "hasDebug", "hasFeedback", "hasLogsAndMetrics", "hasPerformance", "hasReplay" ] }, "useCase": { "type": "string" } }, "required": [ "browserSdk", "browserSdkVersion", "dateCreated", "dsn", "dynamicSdkLoaderOptions", "id", "isActive", "label", "name", "projectId", "public", "rateLimit", "secret" ] } }, "ListOrganizationIntegrationResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "domainName": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "type": "string" }, "provider": {}, "configOrganization": {}, "configData": {}, "externalId": { "type": "string" }, "organizationId": { "type": "integer" }, "organizationIntegrationStatus": { "type": "string" }, "gracePeriodEnd": { "type": "string", "nullable": true } }, "required": [ "accountType", "configData", "configOrganization", "domainName", "externalId", "gracePeriodEnd", "icon", "id", "name", "organizationId", "organizationIntegrationStatus", "provider", "scopes", "status" ] } }, "ListOrganizationMemberResponse": { "type": "array", "items": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "inviterName", "name", "orgRole", "pending" ] } }, "ListOrganizations": { "type": "array", "items": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] } }, "ListProjectEnvironments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isHidden": { "type": "boolean" } }, "required": [ "id", "isHidden", "name" ] } }, "ListReplayClicks": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "node_id": { "type": "integer" }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "node_id", "timestamp" ] } } }, "required": [ "data" ] }, "ListReplayDeletionJobs": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "dateCreated": { "type": "string" }, "dateUpdated": { "type": "string" }, "rangeStart": { "type": "string" }, "rangeEnd": { "type": "string" }, "environments": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "query": { "type": "string" }, "countDeleted": { "type": "integer" } }, "required": [ "countDeleted", "dateCreated", "dateUpdated", "environments", "id", "query", "rangeEnd", "rangeStart", "status" ] } } }, "required": [ "data" ] }, "ListReplayRecordingSegments": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "ListReplays": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "project_id": { "type": "string" }, "trace_ids": { "type": "array", "items": { "type": "string" } }, "error_ids": { "type": "array", "items": { "type": "string" } }, "environment": { "type": "string", "nullable": true }, "tags": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, { "type": "array", "items": {} } ] }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "geo": { "type": "object", "properties": { "city": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "subdivision": { "type": "string", "nullable": true } } } } }, "sdk": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "os": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "browser": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "device": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "family": { "type": "string", "nullable": true } } }, "ota_updates": { "type": "object", "properties": { "channel": { "type": "string", "nullable": true }, "runtime_version": { "type": "string", "nullable": true }, "update_id": { "type": "string", "nullable": true } } }, "is_archived": { "type": "boolean", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "clicks": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "count_dead_clicks": { "type": "integer", "nullable": true }, "count_rage_clicks": { "type": "integer", "nullable": true }, "count_errors": { "type": "integer", "nullable": true }, "duration": { "type": "integer", "nullable": true }, "finished_at": { "type": "string", "nullable": true }, "started_at": { "type": "string", "nullable": true }, "activity": { "type": "integer", "nullable": true }, "count_urls": { "type": "integer", "nullable": true }, "replay_type": { "type": "string" }, "count_segments": { "type": "integer", "nullable": true }, "platform": { "type": "string", "nullable": true }, "releases": { "type": "array", "items": { "type": "string" } }, "dist": { "type": "string", "nullable": true }, "count_warnings": { "type": "integer", "nullable": true }, "count_infos": { "type": "integer", "nullable": true }, "has_viewed": { "type": "boolean" } } } }, "ListSelectors": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "count_dead_clicks": { "type": "integer" }, "count_rage_clicks": { "type": "integer" }, "dom_element": { "type": "string" }, "element": { "type": "object", "properties": { "alt": { "type": "string" }, "aria_label": { "type": "string" }, "class": { "type": "array", "items": { "type": "string" } }, "component_name": { "type": "string" }, "id": { "type": "string" }, "role": { "type": "string" }, "tag": { "type": "string" }, "testid": { "type": "string" }, "title": { "type": "string" } }, "required": [ "alt", "aria_label", "class", "component_name", "id", "role", "tag", "testid", "title" ] }, "project_id": { "type": "string" } } } } }, "required": [ "data" ] }, "ListTeamProjectResponse": { "type": "array", "items": { "type": "object", "properties": { "latestDeploys": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "nullable": true }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "hasUserReports": { "type": "boolean" }, "environments": { "type": "array", "items": { "type": "string" } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true } }, "required": [ "access", "dateCreated", "environments", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "hasUserReports", "id", "isBookmarked", "isMember", "latestRelease", "name", "platform", "platforms", "slug", "team", "teams" ] } }, "ListWorkflow": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "triggers": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } }, "nullable": true }, "actionFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } } }, "nullable": true }, "environment": { "type": "string", "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "detectorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" }, "lastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "string", "nullable": true } }, "required": [ "actionFilters", "config", "createdBy", "dateCreated", "dateUpdated", "detectorIds", "enabled", "environment", "id", "lastTriggered", "name", "organizationId", "owner", "triggers" ] } }, "Monitor": { "type": "object", "properties": { "alertRule": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "targetIdentifier": { "type": "integer" }, "targetType": { "type": "string" } }, "required": [ "targetIdentifier", "targetType" ] } }, "environment": { "type": "string" } }, "required": [ "environment", "targets" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "isUpserting": { "type": "boolean" }, "config": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] }, "environments": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastCheckIn": { "type": "string", "format": "date-time" }, "nextCheckIn": { "type": "string", "format": "date-time" }, "nextCheckInLatest": { "type": "string", "format": "date-time" }, "activeIncident": { "type": "object", "properties": { "startingTimestamp": { "type": "string", "format": "date-time" }, "resolvingTimestamp": { "type": "string", "format": "date-time" }, "brokenNotice": { "type": "object", "properties": { "userNotifiedTimestamp": { "type": "string", "format": "date-time" }, "environmentMutedTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "environmentMutedTimestamp", "userNotifiedTimestamp" ], "nullable": true } }, "required": [ "brokenNotice", "resolvingTimestamp", "startingTimestamp" ], "nullable": true } }, "required": [ "activeIncident", "dateCreated", "isMuted", "lastCheckIn", "name", "nextCheckIn", "nextCheckInLatest", "status" ] }, "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] } }, "required": [ "config", "dateCreated", "environments", "id", "isMuted", "isUpserting", "name", "owner", "project", "slug", "status" ] }, "MonitorList": { "type": "array", "items": { "type": "object", "properties": { "alertRule": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "targetIdentifier": { "type": "integer" }, "targetType": { "type": "string" } }, "required": [ "targetIdentifier", "targetType" ] } }, "environment": { "type": "string" } }, "required": [ "environment", "targets" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "isUpserting": { "type": "boolean" }, "config": { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string" }, "schedule": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "integer" }, "minLength": 2, "maxLength": 2 } ] }, "checkin_margin": { "type": "integer", "nullable": true }, "max_runtime": { "type": "integer", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "failure_issue_threshold": { "type": "integer", "nullable": true }, "recovery_threshold": { "type": "integer", "nullable": true }, "alert_rule_id": { "type": "integer", "nullable": true } }, "required": [ "alert_rule_id", "checkin_margin", "failure_issue_threshold", "max_runtime", "recovery_threshold", "schedule", "schedule_type", "timezone" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] }, "environments": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "isMuted": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastCheckIn": { "type": "string", "format": "date-time" }, "nextCheckIn": { "type": "string", "format": "date-time" }, "nextCheckInLatest": { "type": "string", "format": "date-time" }, "activeIncident": { "type": "object", "properties": { "startingTimestamp": { "type": "string", "format": "date-time" }, "resolvingTimestamp": { "type": "string", "format": "date-time" }, "brokenNotice": { "type": "object", "properties": { "userNotifiedTimestamp": { "type": "string", "format": "date-time" }, "environmentMutedTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "environmentMutedTimestamp", "userNotifiedTimestamp" ], "nullable": true } }, "required": [ "brokenNotice", "resolvingTimestamp", "startingTimestamp" ], "nullable": true } }, "required": [ "activeIncident", "dateCreated", "isMuted", "lastCheckIn", "name", "nextCheckIn", "nextCheckInLatest", "status" ] }, "owner": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] } }, "required": [ "config", "dateCreated", "environments", "id", "isMuted", "isUpserting", "name", "owner", "project", "slug", "status" ] } }, "MonitorValidator": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "project": { "type": "string", "description": "The project slug to associate the monitor to." }, "name": { "type": "string", "description": "Name of the monitor. Used for notifications. If not set the slug will be derived from your monitor name.", "maxLength": 128 }, "config": { "allOf": [ { "type": "object", "properties": { "schedule_type": { "enum": [ "crontab", "interval" ], "type": "string", "description": "Currently supports \"crontab\" or \"interval\"\n\n* `crontab`\n* `interval`" }, "schedule": { "description": "Varies depending on the schedule_type. Is either a crontab string, or a 2 element tuple for intervals (e.g. [1, 'day'])" }, "checkin_margin": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) after the expected checkin time will we wait until we consider the checkin to have been missed." }, "max_runtime": { "type": "integer", "maximum": 40320, "minimum": 1, "nullable": true, "description": "How long (in minutes) is the checkin allowed to run for in CheckInStatus.IN_PROGRESS before it is considered failed." }, "timezone": { "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "localtime", "" ], "type": "string", "description": "tz database style timezone string\n\n* `Africa/Abidjan`\n* `Africa/Accra`\n* `Africa/Addis_Ababa`\n* `Africa/Algiers`\n* `Africa/Asmara`\n* `Africa/Asmera`\n* `Africa/Bamako`\n* `Africa/Bangui`\n* `Africa/Banjul`\n* `Africa/Bissau`\n* `Africa/Blantyre`\n* `Africa/Brazzaville`\n* `Africa/Bujumbura`\n* `Africa/Cairo`\n* `Africa/Casablanca`\n* `Africa/Ceuta`\n* `Africa/Conakry`\n* `Africa/Dakar`\n* `Africa/Dar_es_Salaam`\n* `Africa/Djibouti`\n* `Africa/Douala`\n* `Africa/El_Aaiun`\n* `Africa/Freetown`\n* `Africa/Gaborone`\n* `Africa/Harare`\n* `Africa/Johannesburg`\n* `Africa/Juba`\n* `Africa/Kampala`\n* `Africa/Khartoum`\n* `Africa/Kigali`\n* `Africa/Kinshasa`\n* `Africa/Lagos`\n* `Africa/Libreville`\n* `Africa/Lome`\n* `Africa/Luanda`\n* `Africa/Lubumbashi`\n* `Africa/Lusaka`\n* `Africa/Malabo`\n* `Africa/Maputo`\n* `Africa/Maseru`\n* `Africa/Mbabane`\n* `Africa/Mogadishu`\n* `Africa/Monrovia`\n* `Africa/Nairobi`\n* `Africa/Ndjamena`\n* `Africa/Niamey`\n* `Africa/Nouakchott`\n* `Africa/Ouagadougou`\n* `Africa/Porto-Novo`\n* `Africa/Sao_Tome`\n* `Africa/Timbuktu`\n* `Africa/Tripoli`\n* `Africa/Tunis`\n* `Africa/Windhoek`\n* `America/Adak`\n* `America/Anchorage`\n* `America/Anguilla`\n* `America/Antigua`\n* `America/Araguaina`\n* `America/Argentina/Buenos_Aires`\n* `America/Argentina/Catamarca`\n* `America/Argentina/ComodRivadavia`\n* `America/Argentina/Cordoba`\n* `America/Argentina/Jujuy`\n* `America/Argentina/La_Rioja`\n* `America/Argentina/Mendoza`\n* `America/Argentina/Rio_Gallegos`\n* `America/Argentina/Salta`\n* `America/Argentina/San_Juan`\n* `America/Argentina/San_Luis`\n* `America/Argentina/Tucuman`\n* `America/Argentina/Ushuaia`\n* `America/Aruba`\n* `America/Asuncion`\n* `America/Atikokan`\n* `America/Atka`\n* `America/Bahia`\n* `America/Bahia_Banderas`\n* `America/Barbados`\n* `America/Belem`\n* `America/Belize`\n* `America/Blanc-Sablon`\n* `America/Boa_Vista`\n* `America/Bogota`\n* `America/Boise`\n* `America/Buenos_Aires`\n* `America/Cambridge_Bay`\n* `America/Campo_Grande`\n* `America/Cancun`\n* `America/Caracas`\n* `America/Catamarca`\n* `America/Cayenne`\n* `America/Cayman`\n* `America/Chicago`\n* `America/Chihuahua`\n* `America/Ciudad_Juarez`\n* `America/Coral_Harbour`\n* `America/Cordoba`\n* `America/Costa_Rica`\n* `America/Coyhaique`\n* `America/Creston`\n* `America/Cuiaba`\n* `America/Curacao`\n* `America/Danmarkshavn`\n* `America/Dawson`\n* `America/Dawson_Creek`\n* `America/Denver`\n* `America/Detroit`\n* `America/Dominica`\n* `America/Edmonton`\n* `America/Eirunepe`\n* `America/El_Salvador`\n* `America/Ensenada`\n* `America/Fort_Nelson`\n* `America/Fort_Wayne`\n* `America/Fortaleza`\n* `America/Glace_Bay`\n* `America/Godthab`\n* `America/Goose_Bay`\n* `America/Grand_Turk`\n* `America/Grenada`\n* `America/Guadeloupe`\n* `America/Guatemala`\n* `America/Guayaquil`\n* `America/Guyana`\n* `America/Halifax`\n* `America/Havana`\n* `America/Hermosillo`\n* `America/Indiana/Indianapolis`\n* `America/Indiana/Knox`\n* `America/Indiana/Marengo`\n* `America/Indiana/Petersburg`\n* `America/Indiana/Tell_City`\n* `America/Indiana/Vevay`\n* `America/Indiana/Vincennes`\n* `America/Indiana/Winamac`\n* `America/Indianapolis`\n* `America/Inuvik`\n* `America/Iqaluit`\n* `America/Jamaica`\n* `America/Jujuy`\n* `America/Juneau`\n* `America/Kentucky/Louisville`\n* `America/Kentucky/Monticello`\n* `America/Knox_IN`\n* `America/Kralendijk`\n* `America/La_Paz`\n* `America/Lima`\n* `America/Los_Angeles`\n* `America/Louisville`\n* `America/Lower_Princes`\n* `America/Maceio`\n* `America/Managua`\n* `America/Manaus`\n* `America/Marigot`\n* `America/Martinique`\n* `America/Matamoros`\n* `America/Mazatlan`\n* `America/Mendoza`\n* `America/Menominee`\n* `America/Merida`\n* `America/Metlakatla`\n* `America/Mexico_City`\n* `America/Miquelon`\n* `America/Moncton`\n* `America/Monterrey`\n* `America/Montevideo`\n* `America/Montreal`\n* `America/Montserrat`\n* `America/Nassau`\n* `America/New_York`\n* `America/Nipigon`\n* `America/Nome`\n* `America/Noronha`\n* `America/North_Dakota/Beulah`\n* `America/North_Dakota/Center`\n* `America/North_Dakota/New_Salem`\n* `America/Nuuk`\n* `America/Ojinaga`\n* `America/Panama`\n* `America/Pangnirtung`\n* `America/Paramaribo`\n* `America/Phoenix`\n* `America/Port-au-Prince`\n* `America/Port_of_Spain`\n* `America/Porto_Acre`\n* `America/Porto_Velho`\n* `America/Puerto_Rico`\n* `America/Punta_Arenas`\n* `America/Rainy_River`\n* `America/Rankin_Inlet`\n* `America/Recife`\n* `America/Regina`\n* `America/Resolute`\n* `America/Rio_Branco`\n* `America/Rosario`\n* `America/Santa_Isabel`\n* `America/Santarem`\n* `America/Santiago`\n* `America/Santo_Domingo`\n* `America/Sao_Paulo`\n* `America/Scoresbysund`\n* `America/Shiprock`\n* `America/Sitka`\n* `America/St_Barthelemy`\n* `America/St_Johns`\n* `America/St_Kitts`\n* `America/St_Lucia`\n* `America/St_Thomas`\n* `America/St_Vincent`\n* `America/Swift_Current`\n* `America/Tegucigalpa`\n* `America/Thule`\n* `America/Thunder_Bay`\n* `America/Tijuana`\n* `America/Toronto`\n* `America/Tortola`\n* `America/Vancouver`\n* `America/Virgin`\n* `America/Whitehorse`\n* `America/Winnipeg`\n* `America/Yakutat`\n* `America/Yellowknife`\n* `Antarctica/Casey`\n* `Antarctica/Davis`\n* `Antarctica/DumontDUrville`\n* `Antarctica/Macquarie`\n* `Antarctica/Mawson`\n* `Antarctica/McMurdo`\n* `Antarctica/Palmer`\n* `Antarctica/Rothera`\n* `Antarctica/South_Pole`\n* `Antarctica/Syowa`\n* `Antarctica/Troll`\n* `Antarctica/Vostok`\n* `Arctic/Longyearbyen`\n* `Asia/Aden`\n* `Asia/Almaty`\n* `Asia/Amman`\n* `Asia/Anadyr`\n* `Asia/Aqtau`\n* `Asia/Aqtobe`\n* `Asia/Ashgabat`\n* `Asia/Ashkhabad`\n* `Asia/Atyrau`\n* `Asia/Baghdad`\n* `Asia/Bahrain`\n* `Asia/Baku`\n* `Asia/Bangkok`\n* `Asia/Barnaul`\n* `Asia/Beirut`\n* `Asia/Bishkek`\n* `Asia/Brunei`\n* `Asia/Calcutta`\n* `Asia/Chita`\n* `Asia/Choibalsan`\n* `Asia/Chongqing`\n* `Asia/Chungking`\n* `Asia/Colombo`\n* `Asia/Dacca`\n* `Asia/Damascus`\n* `Asia/Dhaka`\n* `Asia/Dili`\n* `Asia/Dubai`\n* `Asia/Dushanbe`\n* `Asia/Famagusta`\n* `Asia/Gaza`\n* `Asia/Harbin`\n* `Asia/Hebron`\n* `Asia/Ho_Chi_Minh`\n* `Asia/Hong_Kong`\n* `Asia/Hovd`\n* `Asia/Irkutsk`\n* `Asia/Istanbul`\n* `Asia/Jakarta`\n* `Asia/Jayapura`\n* `Asia/Jerusalem`\n* `Asia/Kabul`\n* `Asia/Kamchatka`\n* `Asia/Karachi`\n* `Asia/Kashgar`\n* `Asia/Kathmandu`\n* `Asia/Katmandu`\n* `Asia/Khandyga`\n* `Asia/Kolkata`\n* `Asia/Krasnoyarsk`\n* `Asia/Kuala_Lumpur`\n* `Asia/Kuching`\n* `Asia/Kuwait`\n* `Asia/Macao`\n* `Asia/Macau`\n* `Asia/Magadan`\n* `Asia/Makassar`\n* `Asia/Manila`\n* `Asia/Muscat`\n* `Asia/Nicosia`\n* `Asia/Novokuznetsk`\n* `Asia/Novosibirsk`\n* `Asia/Omsk`\n* `Asia/Oral`\n* `Asia/Phnom_Penh`\n* `Asia/Pontianak`\n* `Asia/Pyongyang`\n* `Asia/Qatar`\n* `Asia/Qostanay`\n* `Asia/Qyzylorda`\n* `Asia/Rangoon`\n* `Asia/Riyadh`\n* `Asia/Saigon`\n* `Asia/Sakhalin`\n* `Asia/Samarkand`\n* `Asia/Seoul`\n* `Asia/Shanghai`\n* `Asia/Singapore`\n* `Asia/Srednekolymsk`\n* `Asia/Taipei`\n* `Asia/Tashkent`\n* `Asia/Tbilisi`\n* `Asia/Tehran`\n* `Asia/Tel_Aviv`\n* `Asia/Thimbu`\n* `Asia/Thimphu`\n* `Asia/Tokyo`\n* `Asia/Tomsk`\n* `Asia/Ujung_Pandang`\n* `Asia/Ulaanbaatar`\n* `Asia/Ulan_Bator`\n* `Asia/Urumqi`\n* `Asia/Ust-Nera`\n* `Asia/Vientiane`\n* `Asia/Vladivostok`\n* `Asia/Yakutsk`\n* `Asia/Yangon`\n* `Asia/Yekaterinburg`\n* `Asia/Yerevan`\n* `Atlantic/Azores`\n* `Atlantic/Bermuda`\n* `Atlantic/Canary`\n* `Atlantic/Cape_Verde`\n* `Atlantic/Faeroe`\n* `Atlantic/Faroe`\n* `Atlantic/Jan_Mayen`\n* `Atlantic/Madeira`\n* `Atlantic/Reykjavik`\n* `Atlantic/South_Georgia`\n* `Atlantic/St_Helena`\n* `Atlantic/Stanley`\n* `Australia/ACT`\n* `Australia/Adelaide`\n* `Australia/Brisbane`\n* `Australia/Broken_Hill`\n* `Australia/Canberra`\n* `Australia/Currie`\n* `Australia/Darwin`\n* `Australia/Eucla`\n* `Australia/Hobart`\n* `Australia/LHI`\n* `Australia/Lindeman`\n* `Australia/Lord_Howe`\n* `Australia/Melbourne`\n* `Australia/NSW`\n* `Australia/North`\n* `Australia/Perth`\n* `Australia/Queensland`\n* `Australia/South`\n* `Australia/Sydney`\n* `Australia/Tasmania`\n* `Australia/Victoria`\n* `Australia/West`\n* `Australia/Yancowinna`\n* `Brazil/Acre`\n* `Brazil/DeNoronha`\n* `Brazil/East`\n* `Brazil/West`\n* `CET`\n* `CST6CDT`\n* `Canada/Atlantic`\n* `Canada/Central`\n* `Canada/Eastern`\n* `Canada/Mountain`\n* `Canada/Newfoundland`\n* `Canada/Pacific`\n* `Canada/Saskatchewan`\n* `Canada/Yukon`\n* `Chile/Continental`\n* `Chile/EasterIsland`\n* `Cuba`\n* `EET`\n* `EST`\n* `EST5EDT`\n* `Egypt`\n* `Eire`\n* `Etc/GMT`\n* `Etc/GMT+0`\n* `Etc/GMT+1`\n* `Etc/GMT+10`\n* `Etc/GMT+11`\n* `Etc/GMT+12`\n* `Etc/GMT+2`\n* `Etc/GMT+3`\n* `Etc/GMT+4`\n* `Etc/GMT+5`\n* `Etc/GMT+6`\n* `Etc/GMT+7`\n* `Etc/GMT+8`\n* `Etc/GMT+9`\n* `Etc/GMT-0`\n* `Etc/GMT-1`\n* `Etc/GMT-10`\n* `Etc/GMT-11`\n* `Etc/GMT-12`\n* `Etc/GMT-13`\n* `Etc/GMT-14`\n* `Etc/GMT-2`\n* `Etc/GMT-3`\n* `Etc/GMT-4`\n* `Etc/GMT-5`\n* `Etc/GMT-6`\n* `Etc/GMT-7`\n* `Etc/GMT-8`\n* `Etc/GMT-9`\n* `Etc/GMT0`\n* `Etc/Greenwich`\n* `Etc/UCT`\n* `Etc/UTC`\n* `Etc/Universal`\n* `Etc/Zulu`\n* `Europe/Amsterdam`\n* `Europe/Andorra`\n* `Europe/Astrakhan`\n* `Europe/Athens`\n* `Europe/Belfast`\n* `Europe/Belgrade`\n* `Europe/Berlin`\n* `Europe/Bratislava`\n* `Europe/Brussels`\n* `Europe/Bucharest`\n* `Europe/Budapest`\n* `Europe/Busingen`\n* `Europe/Chisinau`\n* `Europe/Copenhagen`\n* `Europe/Dublin`\n* `Europe/Gibraltar`\n* `Europe/Guernsey`\n* `Europe/Helsinki`\n* `Europe/Isle_of_Man`\n* `Europe/Istanbul`\n* `Europe/Jersey`\n* `Europe/Kaliningrad`\n* `Europe/Kiev`\n* `Europe/Kirov`\n* `Europe/Kyiv`\n* `Europe/Lisbon`\n* `Europe/Ljubljana`\n* `Europe/London`\n* `Europe/Luxembourg`\n* `Europe/Madrid`\n* `Europe/Malta`\n* `Europe/Mariehamn`\n* `Europe/Minsk`\n* `Europe/Monaco`\n* `Europe/Moscow`\n* `Europe/Nicosia`\n* `Europe/Oslo`\n* `Europe/Paris`\n* `Europe/Podgorica`\n* `Europe/Prague`\n* `Europe/Riga`\n* `Europe/Rome`\n* `Europe/Samara`\n* `Europe/San_Marino`\n* `Europe/Sarajevo`\n* `Europe/Saratov`\n* `Europe/Simferopol`\n* `Europe/Skopje`\n* `Europe/Sofia`\n* `Europe/Stockholm`\n* `Europe/Tallinn`\n* `Europe/Tirane`\n* `Europe/Tiraspol`\n* `Europe/Ulyanovsk`\n* `Europe/Uzhgorod`\n* `Europe/Vaduz`\n* `Europe/Vatican`\n* `Europe/Vienna`\n* `Europe/Vilnius`\n* `Europe/Volgograd`\n* `Europe/Warsaw`\n* `Europe/Zagreb`\n* `Europe/Zaporozhye`\n* `Europe/Zurich`\n* `GB`\n* `GB-Eire`\n* `GMT`\n* `GMT+0`\n* `GMT-0`\n* `GMT0`\n* `Greenwich`\n* `HST`\n* `Hongkong`\n* `Iceland`\n* `Indian/Antananarivo`\n* `Indian/Chagos`\n* `Indian/Christmas`\n* `Indian/Cocos`\n* `Indian/Comoro`\n* `Indian/Kerguelen`\n* `Indian/Mahe`\n* `Indian/Maldives`\n* `Indian/Mauritius`\n* `Indian/Mayotte`\n* `Indian/Reunion`\n* `Iran`\n* `Israel`\n* `Jamaica`\n* `Japan`\n* `Kwajalein`\n* `Libya`\n* `MET`\n* `MST`\n* `MST7MDT`\n* `Mexico/BajaNorte`\n* `Mexico/BajaSur`\n* `Mexico/General`\n* `NZ`\n* `NZ-CHAT`\n* `Navajo`\n* `PRC`\n* `PST8PDT`\n* `Pacific/Apia`\n* `Pacific/Auckland`\n* `Pacific/Bougainville`\n* `Pacific/Chatham`\n* `Pacific/Chuuk`\n* `Pacific/Easter`\n* `Pacific/Efate`\n* `Pacific/Enderbury`\n* `Pacific/Fakaofo`\n* `Pacific/Fiji`\n* `Pacific/Funafuti`\n* `Pacific/Galapagos`\n* `Pacific/Gambier`\n* `Pacific/Guadalcanal`\n* `Pacific/Guam`\n* `Pacific/Honolulu`\n* `Pacific/Johnston`\n* `Pacific/Kanton`\n* `Pacific/Kiritimati`\n* `Pacific/Kosrae`\n* `Pacific/Kwajalein`\n* `Pacific/Majuro`\n* `Pacific/Marquesas`\n* `Pacific/Midway`\n* `Pacific/Nauru`\n* `Pacific/Niue`\n* `Pacific/Norfolk`\n* `Pacific/Noumea`\n* `Pacific/Pago_Pago`\n* `Pacific/Palau`\n* `Pacific/Pitcairn`\n* `Pacific/Pohnpei`\n* `Pacific/Ponape`\n* `Pacific/Port_Moresby`\n* `Pacific/Rarotonga`\n* `Pacific/Saipan`\n* `Pacific/Samoa`\n* `Pacific/Tahiti`\n* `Pacific/Tarawa`\n* `Pacific/Tongatapu`\n* `Pacific/Truk`\n* `Pacific/Wake`\n* `Pacific/Wallis`\n* `Pacific/Yap`\n* `Poland`\n* `Portugal`\n* `ROC`\n* `ROK`\n* `Singapore`\n* `Turkey`\n* `UCT`\n* `US/Alaska`\n* `US/Aleutian`\n* `US/Arizona`\n* `US/Central`\n* `US/East-Indiana`\n* `US/Eastern`\n* `US/Hawaii`\n* `US/Indiana-Starke`\n* `US/Michigan`\n* `US/Mountain`\n* `US/Pacific`\n* `US/Samoa`\n* `UTC`\n* `Universal`\n* `W-SU`\n* `WET`\n* `Zulu`\n* `localtime`" }, "failure_issue_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many consecutive missed or failed check-ins in a row before creating a new issue." }, "recovery_threshold": { "type": "integer", "maximum": 720, "minimum": 1, "nullable": true, "description": "How many successful check-ins in a row before resolving an issue." } }, "required": [ "schedule" ] } ], "description": "The configuration for the monitor." }, "slug": { "type": "string", "description": "Uniquely identifies your monitor within your organization. Changing this slug will require updates to any instrumented check-in calls.", "maxLength": 50, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "status": { "enum": [ "active", "disabled" ], "type": "string", "default": "active", "description": "Status of the monitor. Disabled monitors will not accept events and will not count towards the monitor quota.\n\n* `active`\n* `disabled`" }, "owner": { "type": "string", "nullable": true, "description": "The ID of the team or user that owns the monitor. (eg. user:51 or team:6)" }, "is_muted": { "type": "boolean", "description": "Disable creation of monitor incidents" } }, "required": [ "config", "name", "project" ] }, "NotificationAction": { "type": "object", "description": "Django Rest Framework serializer for incoming NotificationAction API payloads", "properties": { "trigger_type": { "type": "string", "description": "Type of the trigger that causes the notification. The only supported trigger right now is: `spike-protection`." }, "service_type": { "type": "string", "description": "Service that is used for sending the notification.\n- `email`\n- `slack`\n- `sentry_notification`\n- `pagerduty`\n- `opsgenie`\n" }, "integration_id": { "type": "integer", "description": "ID of the integration used as the notification service. See\n[List Integrations](https://docs.sentry.io/api/integrations/list-an-organizations-available-integrations/)\nto retrieve a full list of integrations.\n\nRequired if **service_type** is `slack`, `pagerduty` or `opsgenie`.\n" }, "target_identifier": { "type": "string", "description": "ID of the notification target, like a Slack channel ID.\n\nRequired if **service_type** is `slack` or `opsgenie`.\n" }, "target_display": { "type": "string", "description": "Name of the notification target, like a Slack channel name.\n\nRequired if **service_type** is `slack` or `opsgenie`.\n" }, "projects": { "type": "array", "items": { "type": "string" }, "description": "List of projects slugs that the Notification Action is created for." } }, "required": [ "service_type", "trigger_type" ] }, "OrgReleaseResponse": { "type": "object", "properties": { "ref": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "object", "additionalProperties": {}, "nullable": true }, "lastCommit": { "type": "object", "additionalProperties": {}, "nullable": true }, "lastDeploy": { "type": "object", "properties": { "dateStarted": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "id": { "type": "string" }, "environment": { "type": "string" }, "dateFinished": { "type": "string" }, "name": { "type": "string" } }, "required": [ "dateFinished", "environment", "id", "name" ], "nullable": true }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "lastEvent": { "type": "string", "format": "date-time", "nullable": true }, "currentProjectMeta": { "type": "object", "additionalProperties": {}, "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "adoptionStages": { "type": "object", "additionalProperties": {}, "nullable": true }, "id": { "type": "integer" }, "version": { "type": "string" }, "newGroups": { "type": "integer" }, "status": { "type": "string" }, "shortVersion": { "type": "string" }, "versionInfo": { "type": "object", "properties": { "description": { "type": "string" }, "package": { "type": "string", "nullable": true }, "version": { "type": "object", "additionalProperties": {} }, "buildHash": { "type": "string", "nullable": true } }, "required": [ "buildHash", "package", "version" ], "nullable": true }, "data": { "type": "object", "additionalProperties": {} }, "commitCount": { "type": "integer" }, "deployCount": { "type": "integer" }, "authors": { "type": "array", "items": { "type": "object", "properties": { "lastLogin": { "type": "string" }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string" }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number", "format": "double" }, { "type": "boolean" }, { "type": "object", "nullable": true } ] } }, "emails": { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "boolean" } ] } } }, "avatar": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "id": { "type": "integer" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string" } }, "required": [ "avatarUrl", "dateJoined", "email", "hasPasswordAuth", "id", "isActive", "isManaged", "isSuspended", "name", "username" ] } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "healthData": { "type": "object", "properties": { "durationP50": { "type": "number", "format": "double", "nullable": true }, "durationP90": { "type": "number", "format": "double", "nullable": true }, "crashFreeUsers": { "type": "number", "format": "double", "nullable": true }, "crashFreeSessions": { "type": "number", "format": "double", "nullable": true }, "totalUsers": { "type": "integer", "nullable": true }, "totalUsers24h": { "type": "integer", "nullable": true }, "totalProjectUsers24h": { "type": "integer", "nullable": true }, "totalSessions": { "type": "integer", "nullable": true }, "totalSessions24h": { "type": "integer", "nullable": true }, "totalProjectSessions24h": { "type": "integer", "nullable": true }, "adoption": { "type": "number", "format": "double", "nullable": true }, "sessionsAdoption": { "type": "number", "format": "double", "nullable": true }, "sessionsCrashed": { "type": "integer" }, "sessionsErrored": { "type": "integer" }, "hasHealthData": { "type": "boolean" }, "stats": { "type": "object", "additionalProperties": {} } }, "required": [ "hasHealthData", "sessionsCrashed", "sessionsErrored", "stats" ], "nullable": true }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "platforms": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hasHealthData": { "type": "boolean" }, "newGroups": { "type": "integer" } }, "required": [ "hasHealthData", "id", "name", "newGroups", "platform", "platforms", "slug" ] } } }, "required": [ "authors", "commitCount", "data", "deployCount", "id", "newGroups", "projects", "shortVersion", "status", "version", "versionInfo" ] }, "OrganizationConfigIntegrationsEndpointResponse": { "type": "object", "properties": { "providers": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "metadata": {}, "canAdd": { "type": "boolean" }, "canDisable": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "setupDialog": { "type": "object", "additionalProperties": {} } }, "required": [ "canAdd", "canDisable", "features", "key", "metadata", "name", "setupDialog", "slug" ] } } }, "required": [ "providers" ] }, "OrganizationDetailsPut": { "type": "object", "properties": { "slug": { "type": "string", "description": "The new slug for the organization, which needs to be unique.", "maxLength": 50 }, "name": { "type": "string", "description": "The new name for the organization.", "maxLength": 64 }, "isEarlyAdopter": { "type": "boolean", "description": "Specify `true` to opt-in to new features before they're released to the public." }, "hideAiFeatures": { "type": "boolean", "description": "Specify `true` to hide AI features from the organization." }, "codecovAccess": { "type": "boolean", "description": "Specify `true` to enable Code Coverage Insights. This feature is only available for organizations on the Team plan and above. Learn more about Codecov [here](/product/codecov/)." }, "defaultRole": { "enum": [ "member", "admin", "manager", "owner" ], "type": "string", "description": "The default role new members will receive.\n\n* `member` - Member\n* `admin` - Admin\n* `manager` - Manager\n* `owner` - Owner" }, "openMembership": { "type": "boolean", "description": "Specify `true` to allow organization members to freely join any team." }, "eventsMemberAdmin": { "type": "boolean", "description": "Specify `true` to allow members to delete events (including the delete & discard action) by granting them the `event:admin` scope." }, "alertsMemberWrite": { "type": "boolean", "description": "Specify `true` to allow members to create, edit, and delete alert rules by granting them the `alerts:write` scope." }, "attachmentsRole": { "enum": [ "member", "admin", "manager", "owner" ], "type": "string", "description": "The role required to download event attachments, such as native crash reports or log files.\n\n* `member` - Member\n* `admin` - Admin\n* `manager` - Manager\n* `owner` - Owner" }, "debugFilesRole": { "enum": [ "member", "admin", "manager", "owner" ], "type": "string", "description": "The role required to download debug information files, ProGuard mappings and source maps.\n\n* `member` - Member\n* `admin` - Admin\n* `manager` - Manager\n* `owner` - Owner" }, "hasGranularReplayPermissions": { "type": "boolean", "description": "Specify `true` to enable granular replay permissions, allowing per-member access control for replay data." }, "replayAccessMembers": { "type": "array", "items": { "type": "integer" }, "nullable": true, "description": "A list of user IDs who have permission to access replay data. Requires the hasGranularReplayPermissions flag to be true to be enforced." }, "avatarType": { "enum": [ "letter_avatar", "upload" ], "type": "string", "description": "The type of display picture for the organization.\n\n* `letter_avatar` - Use initials\n* `upload` - Upload an image" }, "avatar": { "type": "string", "description": "The image to upload as the organization avatar, in base64. Required if `avatarType` is `upload`." }, "require2FA": { "type": "boolean", "description": "Specify `true` to require and enforce two-factor authentication for all members." }, "allowSharedIssues": { "type": "boolean", "description": "Specify `true` to allow sharing of limited details on issues to anonymous users." }, "enhancedPrivacy": { "type": "boolean", "description": "Specify `true` to enable enhanced privacy controls to limit personally identifiable information (PII) as well as source code in things like notifications." }, "scrapeJavaScript": { "type": "boolean", "description": "Specify `true` to allow Sentry to scrape missing JavaScript source context when possible." }, "storeCrashReports": { "enum": [ 0, 1, 5, 10, 20, 50, 100, -1 ], "type": "integer", "description": "How many native crash reports (such as Minidumps for improved processing and download in issue details) to store per issue.\n\n* `0` - Disabled\n* `1` - 1 per issue\n* `5` - 5 per issue\n* `10` - 10 per issue\n* `20` - 20 per issue\n* `50` - 50 per issue\n* `100` - 100 per issue\n* `-1` - Unlimited" }, "allowJoinRequests": { "type": "boolean", "description": "Specify `true` to allow users to request to join your organization." }, "dataScrubber": { "type": "boolean", "description": "Specify `true` to require server-side data scrubbing for all projects." }, "dataScrubberDefaults": { "type": "boolean", "description": "Specify `true` to apply the default scrubbers to prevent things like passwords and credit cards from being stored for all projects." }, "sensitiveFields": { "type": "array", "items": { "type": "string" }, "description": "A list of additional global field names to match against when scrubbing data for all projects." }, "safeFields": { "type": "array", "items": { "type": "string" }, "description": "A list of global field names which data scrubbers should ignore." }, "scrubIPAddresses": { "type": "boolean", "description": "Specify `true` to prevent IP addresses from being stored for new events on all projects." }, "relayPiiConfig": { "type": "string", "description": "Advanced data scrubbing rules that can be configured for each project as a JSON string. The new rules will only apply to new incoming events. For more details on advanced data scrubbing, see our [full documentation](/security-legal-pii/scrubbing/advanced-datascrubbing/).\n\n> Warning: Calling this endpoint with this field fully overwrites the advanced data scrubbing rules.\n\nBelow is an example of a payload for a set of advanced data scrubbing rules for masking credit card numbers from the log message (equivalent to `[Mask] [Credit card numbers] from [$message]` in the Sentry app) and removing a specific key called `foo` (equivalent to `[Remove] [Anything] from [extra.foo]` in the Sentry app):\n```json\n{\n relayPiiConfig: \"{\\\"rules\":{\\\"0\\\":{\\\"type\\\":\\\"creditcard\\\",\\\"redaction\\\":{\\\"method\\\":\\\"mask\\\"}},\\\"1\\\":{\\\"type\\\":\\\"anything\\\",\\\"redaction\\\":{\\\"method\\\":\\\"remove\\\"}}},\\\"applications\\\":{\\\"$message\\\":[\\\"0\\\"],\\\"extra.foo\\\":[\\\"1\\\"]}}\"\n}\n```\n " }, "trustedRelays": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "A list of local Relays (the name, public key, and description as a JSON) registered for the organization. This feature is only available for organizations on the Business and Enterprise plans. Read more about Relay [here](/product/relay/).\n\n Below is an example of a list containing a single local Relay registered for the organization:\n ```json\n {\n trustedRelays: [\n {\n name: \"my-relay\",\n publicKey: \"eiwr9fdruw4erfh892qy4493reyf89ur34wefd90h\",\n description: \"Configuration for my-relay.\"\n }\n ]\n }\n ```\n " }, "issueAlertsThreadFlag": { "type": "boolean", "description": "Specify `true` to allow the Sentry Slack integration to post replies in threads for an Issue Alert notification. Requires a Slack integration." }, "metricAlertsThreadFlag": { "type": "boolean", "description": "Specify `true` to allow the Sentry Slack integration to post replies in threads for a Metric Alert notification. Requires a Slack integration." }, "cancelDeletion": { "type": "boolean", "description": "Specify `true` to restore an organization that is pending deletion." } } }, "OrganizationEnvironmentResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } }, "OrganizationEventsResponseDict": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "type": "string" } }, "datasetReason": { "type": "string" }, "isMetricsData": { "type": "boolean" }, "isMetricsExtractedData": { "type": "boolean" } }, "required": [ "fields" ] } }, "required": [ "data", "meta" ] }, "OrganizationEventsTimeseriesResponse": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "dataset": { "type": "string" }, "start": { "type": "number", "format": "double" }, "end": { "type": "number", "format": "double" } }, "required": [ "dataset", "end", "start" ] }, "timeSeries": { "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "incomplete": { "type": "boolean" }, "comparisonValue": { "type": "number", "format": "double" }, "sampleCount": { "type": "number", "format": "double" }, "sampleRate": { "type": "number", "format": "double", "nullable": true }, "confidence": { "enum": [ "low", "high" ], "type": "string", "nullable": true }, "incompleteReason": { "type": "string" } }, "required": [ "incomplete", "timestamp", "value" ] } }, "yAxis": { "type": "string" }, "groupBy": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number", "format": "double" }, { "type": "object", "nullable": true } ] } }, "required": [ "key", "value" ] } }, "meta": { "type": "object", "properties": { "order": { "type": "integer" }, "isOther": { "type": "boolean" }, "valueUnit": { "type": "string", "nullable": true }, "dataScanned": { "enum": [ "partial", "full" ], "type": "string" }, "valueType": { "type": "string" }, "interval": { "type": "number", "format": "double" } }, "required": [ "interval", "valueType", "valueUnit" ] } }, "required": [ "meta", "values", "yAxis" ] } } }, "required": [ "timeSeries" ] }, "OrganizationGroupIndexGetResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "shareId": { "type": "string" }, "shortId": { "type": "string" }, "title": { "type": "string" }, "culprit": { "type": "string", "nullable": true }, "permalink": { "type": "string" }, "logger": { "type": "string", "nullable": true }, "level": { "type": "string" }, "status": { "type": "string" }, "statusDetails": { "type": "object", "properties": { "autoResolved": { "type": "boolean" }, "ignoreCount": { "type": "integer" }, "ignoreUntil": { "type": "string", "format": "date-time" }, "ignoreUserCount": { "type": "integer" }, "ignoreUserWindow": { "type": "integer" }, "ignoreWindow": { "type": "integer" }, "actor": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "inNextRelease": { "type": "boolean" }, "inRelease": { "type": "string" }, "inCommit": { "type": "string" }, "pendingEvents": { "type": "integer" }, "info": {} } }, "substatus": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" }, "platform": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "priorityLockedAt": { "type": "string", "format": "date-time", "nullable": true }, "seerFixabilityScore": { "type": "number", "format": "double", "nullable": true }, "seerAutofixLastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "seerExplorerAutofixLastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "name", "platform", "slug" ] }, "type": { "type": "string" }, "issueType": { "type": "string" }, "issueCategory": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} }, "numComments": { "type": "integer" }, "assignedTo": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] }, "isBookmarked": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "subscriptionDetails": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "reason": { "type": "string" } }, "nullable": true }, "hasSeen": { "type": "boolean" }, "annotations": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string" }, "url": { "type": "string" } }, "required": [ "displayName", "url" ] } }, "isUnhandled": { "type": "boolean" }, "count": { "type": "string" }, "userCount": { "type": "integer" }, "firstSeen": { "type": "string", "format": "date-time", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "stats": { "type": "object", "additionalProperties": {} }, "lifetime": { "type": "object", "additionalProperties": {} }, "filtered": { "type": "object", "properties": { "count": { "type": "string" }, "userCount": { "type": "integer" }, "firstSeen": { "type": "string", "format": "date-time", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "stats": { "type": "object", "additionalProperties": {} } }, "required": [ "count", "firstSeen", "lastSeen", "stats", "userCount" ], "nullable": true }, "sessionCount": { "type": "integer" }, "inbox": { "type": "object", "properties": { "reason": { "type": "integer" }, "reason_details": { "type": "object", "properties": { "until": { "type": "string", "nullable": true }, "count": { "type": "integer", "nullable": true }, "window": { "type": "integer", "nullable": true }, "user_count": { "type": "integer", "nullable": true }, "user_window": { "type": "integer", "nullable": true } }, "required": [ "count", "until", "user_count", "user_window", "window" ], "nullable": true }, "date_added": { "type": "string", "format": "date-time" } }, "required": [ "date_added", "reason", "reason_details" ] }, "owners": { "type": "object", "properties": { "type": { "type": "string" }, "owner": { "type": "string" }, "date_added": { "type": "string", "format": "date-time" } }, "required": [ "date_added", "owner", "type" ] }, "pluginActions": { "type": "array", "items": { "type": "array", "items": { "type": "string" }, "minLength": 2, "maxLength": 2 } }, "pluginIssues": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "integrationIssues": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "sentryAppIssues": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "latestEventHasAttachments": { "type": "boolean" } }, "required": [ "annotations", "assignedTo", "count", "culprit", "filtered", "firstSeen", "hasSeen", "id", "inbox", "integrationIssues", "isBookmarked", "isPublic", "isSubscribed", "isUnhandled", "issueCategory", "issueType", "lastSeen", "latestEventHasAttachments", "level", "lifetime", "logger", "metadata", "numComments", "owners", "permalink", "platform", "pluginActions", "pluginIssues", "priority", "priorityLockedAt", "project", "seerAutofixLastTriggered", "seerExplorerAutofixLastTriggered", "seerFixabilityScore", "sentryAppIssues", "sessionCount", "shareId", "shortId", "stats", "status", "statusDetails", "subscriptionDetails", "substatus", "title", "type", "userCount" ] } }, "OrganizationGroupIndexPutResponse": { "type": "object", "properties": { "assignedTo": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] }, "discard": { "type": "boolean" }, "hasSeen": { "type": "boolean" }, "inbox": { "type": "boolean" }, "isBookmarked": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "merge": { "type": "object", "properties": { "parent": { "type": "string" }, "children": { "type": "array", "items": { "type": "string" } } }, "required": [ "children", "parent" ] }, "priority": { "type": "string" }, "shareId": { "type": "string" }, "status": { "type": "string" }, "statusDetails": { "type": "object", "properties": { "inNextRelease": { "type": "boolean" }, "inRelease": { "type": "string" }, "inCommit": { "type": "object", "properties": { "commit": { "type": "string" }, "repository": { "type": "string" } }, "required": [ "commit", "repository" ] }, "ignoreDuration": { "type": "integer" }, "ignoreCount": { "type": "integer" }, "ignoreWindow": { "type": "integer" }, "ignoreUserCount": { "type": "integer" }, "ignoreUserWindow": { "type": "integer" } } }, "subscriptionDetails": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "reason": { "type": "string" } } }, "substatus": { "type": "string" } } }, "OrganizationIntegrationResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "domainName": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "status": { "type": "string" }, "provider": {}, "configOrganization": {}, "configData": {}, "externalId": { "type": "string" }, "organizationId": { "type": "integer" }, "organizationIntegrationStatus": { "type": "string" }, "gracePeriodEnd": { "type": "string", "nullable": true } }, "required": [ "accountType", "configData", "configOrganization", "domainName", "externalId", "gracePeriodEnd", "icon", "id", "name", "organizationId", "organizationIntegrationStatus", "provider", "scopes", "status" ] }, "OrganizationMember": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "inviterName", "name", "orgRole", "pending" ] }, "OrganizationMemberRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "The email address to send the invitation to.", "maxLength": 75 }, "orgRole": { "enum": [ "billing", "member", "manager", "owner", "admin" ], "type": "string", "default": "member", "description": "The organization-level role of the new member. Roles include:\n\n* `billing` - Can manage payment and compliance details.\n* `member` - Can view and act on events, as well as view most other data within the organization.\n* `manager` - Has full management access to all teams and projects. Can also manage\n the organization's membership.\n* `owner` - Has unrestricted access to the organization, its data, and its\n settings. Can add, modify, and delete projects and members, as well as\n make billing and plan changes.\n* `admin` - Can edit global integrations, manage projects, and add/remove teams.\n They automatically assume the Team Admin role for teams they join.\n Note: This role can no longer be assigned in Business and Enterprise plans. Use `TeamRoles` instead.\n " }, "teamRoles": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true, "description": "The team and team-roles assigned to the member. Team roles can be either:\n - `contributor` - Can view and act on issues. Depending on organization settings, they can also add team members.\n - `admin` - Has full management access to their team's membership and projects." }, "sendInvite": { "type": "boolean", "writeOnly": true, "default": true, "description": "Whether or not to send an invite notification through email. Defaults to True." }, "reinvite": { "type": "boolean", "description": "Whether or not to re-invite a user who has already been invited to the organization. Defaults to True." } }, "required": [ "email" ] }, "OrganizationMemberSCIM": { "type": "object", "description": "Conforming to the SCIM RFC, this represents a Sentry Org Member\nas a SCIM user object.", "properties": { "active": { "type": "boolean" }, "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } }, "required": [ "familyName", "givenName" ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "primary": { "type": "boolean" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "primary", "type", "value" ] } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "sentryOrgRole": { "type": "string" } }, "required": [ "emails", "id", "meta", "name", "schemas", "sentryOrgRole", "userName" ] }, "OrganizationMemberTeam": { "type": "object", "properties": { "teamRole": { "enum": [ "contributor", "admin" ], "type": "string", "default": "contributor", "description": "The team-level role to switch to. Valid roles include:\n\n* `contributor` - Contributors can view and act on events, as well as view most other data within the team's projects.\n* `admin` - Admin privileges on the team. They can create and remove projects, and can manage the team's memberships." } } }, "OrganizationMemberTeamDetails": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "teamRole": { "enum": [ "contributor", "admin" ], "type": "string" } }, "required": [ "isActive", "teamRole" ] }, "OrganizationMemberWithRoles": { "type": "object", "properties": { "externalUsers": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "role": { "type": "string" }, "roleName": { "type": "string" }, "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "orgRole": { "type": "string" }, "pending": { "type": "boolean" }, "expired": { "type": "boolean" }, "flags": { "type": "object", "properties": { "idp:provisioned": { "type": "boolean" }, "idp:role-restricted": { "type": "boolean" }, "sso:linked": { "type": "boolean" }, "sso:invalid": { "type": "boolean" }, "member-limit:restricted": { "type": "boolean" }, "partnership:restricted": { "type": "boolean" } }, "required": [ "idp:provisioned", "idp:role-restricted", "member-limit:restricted", "partnership:restricted", "sso:invalid", "sso:linked" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "inviteStatus": { "type": "string" }, "inviterName": { "type": "string", "nullable": true }, "teams": { "type": "array", "items": { "type": "string" } }, "teamRoles": { "type": "array", "items": { "type": "object", "properties": { "teamSlug": { "type": "string" }, "role": { "type": "string", "nullable": true } }, "required": [ "role", "teamSlug" ] } }, "invite_link": { "type": "string", "nullable": true }, "isOnlyOwner": { "type": "boolean" }, "orgRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "is_global": { "type": "boolean" }, "isGlobal": { "type": "boolean" }, "minimumTeamRole": { "type": "string" } }, "required": [ "allowed", "desc", "id", "isAllowed", "isGlobal", "isRetired", "isTeamRolesAllowed", "is_global", "minimumTeamRole", "name", "scopes" ] } }, "teamRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "isMinimumRoleFor": { "type": "string", "nullable": true } }, "required": [ "allowed", "desc", "id", "isAllowed", "isMinimumRoleFor", "isRetired", "isTeamRolesAllowed", "name", "scopes" ] } } }, "required": [ "dateCreated", "email", "expired", "flags", "id", "inviteStatus", "invite_link", "inviterName", "isOnlyOwner", "name", "orgRole", "orgRoleList", "pending", "teamRoleList", "teamRoles", "teams" ] }, "OrganizationProjectResponseDict": { "type": "array", "items": { "type": "object", "properties": { "latestDeploys": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "nullable": true }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "hasUserReports": { "type": "boolean" }, "environments": { "type": "array", "items": { "type": "string" } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true } }, "required": [ "access", "dateCreated", "environments", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "hasUserReports", "id", "isBookmarked", "isMember", "latestRelease", "name", "platform", "platforms", "slug", "team", "teams" ] } }, "OrganizationRelayResponse": { "type": "array", "items": { "type": "object", "properties": { "relayId": { "type": "string" }, "version": { "type": "string" }, "publicKey": { "type": "string" }, "firstSeen": { "type": "string" }, "lastSeen": { "type": "string" } }, "required": [ "firstSeen", "lastSeen", "publicKey", "relayId", "version" ] } }, "OrganizationRelease": { "type": "object", "properties": { "ref": { "type": "string", "nullable": true, "description": "An optional commit reference. This is useful if a tagged version has been provided.", "maxLength": 200 }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "A URL that points to the release. For instance, this can be the path to an online interface to the source code, such as a GitHub URL." }, "dateReleased": { "type": "string", "format": "date-time", "nullable": true, "description": "An optional date that indicates when the release went live. If not provided the current time is used." }, "commits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 64 }, "repository": { "type": "string", "nullable": true, "maxLength": 64 }, "message": { "type": "string", "nullable": true }, "author_name": { "type": "string", "nullable": true, "maxLength": 128 }, "author_email": { "type": "string", "nullable": true, "maxLength": 200 }, "timestamp": { "type": "string", "format": "date-time", "nullable": true }, "patch_set": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "maxLength": 510 }, "type": { "type": "string", "maxLength": 1 } }, "required": [ "path", "type" ] }, "nullable": true } }, "required": [ "id" ] }, "description": "An optional list of commit data to be associated." }, "refs": { "type": "array", "items": { "type": "object", "properties": { "commit": { "type": "string" }, "repository": { "type": "string", "maxLength": 200 }, "previousCommit": { "type": "string", "nullable": true, "maxLength": 64 } }, "required": [ "commit", "repository" ] }, "description": "An optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters ``repository`` and ``commit`` (the HEAD SHA). For GitLab repositories, please use the Group name instead of the slug. They can optionally include ``previousCommit`` (the SHA of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data." } } }, "OrganizationSentryAppDetailsResponse": { "type": "array", "items": { "type": "object", "properties": { "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "avatars": { "type": "array", "items": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string" }, "avatarUrl": { "type": "string" }, "color": { "type": "boolean" }, "photoType": { "type": "string" } }, "required": [ "avatarType", "avatarUrl", "avatarUuid", "color", "photoType" ] } }, "events": { "type": "array", "items": { "type": "string" } }, "featureData": { "type": "array", "items": { "type": "string" } }, "isAlertable": { "type": "boolean" }, "metadata": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string" }, "status": { "type": "string" }, "uuid": { "type": "string" }, "verifyInstall": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "author": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "popularity": { "type": "integer", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true }, "webhookUrl": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "datePublished": { "type": "string", "format": "date-time" }, "clientId": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ] } }, "required": [ "allowedOrigins", "avatars", "events", "featureData", "isAlertable", "metadata", "name", "schema", "scopes", "slug", "status", "uuid", "verifyInstall" ] } }, "OrganizationStatsSummaryResponse": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "stats": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "id", "slug", "stats" ] } } }, "required": [ "end", "projects", "start" ] }, "OrganizationSummary": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "OrganizationWithProjectsAndTeams": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" }, "role": {}, "orgRole": { "type": "string" }, "targetSampleRate": { "type": "number", "format": "double" }, "samplingMode": { "type": "string" }, "planSampleRate": { "type": "number", "format": "double" }, "desiredSampleRate": { "type": "number", "format": "double" }, "experiments": { "type": "object", "additionalProperties": { "type": "string" } }, "isDefault": { "type": "boolean" }, "defaultRole": { "type": "string" }, "orgRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "is_global": { "type": "boolean" }, "isGlobal": { "type": "boolean" }, "minimumTeamRole": { "type": "string" } }, "required": [ "allowed", "desc", "id", "isAllowed", "isGlobal", "isRetired", "isTeamRolesAllowed", "is_global", "minimumTeamRole", "name", "scopes" ] } }, "teamRoleList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowed": { "type": "boolean" }, "isAllowed": { "type": "boolean" }, "isRetired": { "type": "boolean" }, "isTeamRolesAllowed": { "type": "boolean" }, "isMinimumRoleFor": { "type": "string", "nullable": true } }, "required": [ "allowed", "desc", "id", "isAllowed", "isMinimumRoleFor", "isRetired", "isTeamRolesAllowed", "name", "scopes" ] } }, "openMembership": { "type": "boolean" }, "allowSharedIssues": { "type": "boolean" }, "enhancedPrivacy": { "type": "boolean" }, "dataScrubber": { "type": "boolean" }, "dataScrubberDefaults": { "type": "boolean" }, "sensitiveFields": { "type": "array", "items": { "type": "string" } }, "safeFields": { "type": "array", "items": { "type": "string" } }, "storeCrashReports": { "type": "integer" }, "attachmentsRole": { "type": "string" }, "debugFilesRole": { "type": "string" }, "eventsMemberAdmin": { "type": "boolean" }, "alertsMemberWrite": { "type": "boolean" }, "scrubIPAddresses": { "type": "boolean" }, "scrapeJavaScript": { "type": "boolean" }, "allowJoinRequests": { "type": "boolean" }, "relayPiiConfig": { "type": "string", "nullable": true }, "trustedRelays": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "publicKey": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "lastModified": { "type": "string", "format": "date-time" } } } }, "pendingAccessRequests": { "type": "integer" }, "codecovAccess": { "type": "boolean" }, "hideAiFeatures": { "type": "boolean" }, "aggregatedDataConsent": { "type": "boolean" }, "isDynamicallySampled": { "type": "boolean" }, "issueAlertsThreadFlag": { "type": "boolean" }, "metricAlertsThreadFlag": { "type": "boolean" }, "requiresSso": { "type": "boolean" }, "defaultAutofixAutomationTuning": { "type": "string" }, "defaultSeerScannerAutomation": { "type": "boolean" }, "enableSeerCoding": { "type": "boolean" }, "defaultCodingAgent": { "type": "string" }, "defaultCodingAgentIntegrationId": { "type": "string", "nullable": true }, "defaultAutomatedRunStoppingPoint": { "type": "string" }, "autoEnableCodeReview": { "type": "boolean" }, "autoOpenPrs": { "type": "boolean" }, "defaultCodeReviewTriggers": { "type": "array", "items": { "type": "string" } }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "latestDeploys": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "nullable": true }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "hasUserReports": { "type": "boolean" }, "environments": { "type": "array", "items": { "type": "string" } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true } }, "required": [ "access", "dateCreated", "environments", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "hasUserReports", "id", "isBookmarked", "isMember", "latestRelease", "name", "platform", "platforms", "slug", "team", "teams" ] } } }, "required": [ "aggregatedDataConsent", "alertsMemberWrite", "allowJoinRequests", "allowMemberInvite", "allowMemberProjectCreation", "allowSharedIssues", "allowSuperuserAccess", "attachmentsRole", "autoEnableCodeReview", "autoOpenPrs", "avatar", "codecovAccess", "dataScrubber", "dataScrubberDefaults", "dateCreated", "debugFilesRole", "defaultAutofixAutomationTuning", "defaultAutomatedRunStoppingPoint", "defaultCodeReviewTriggers", "defaultCodingAgent", "defaultCodingAgentIntegrationId", "defaultRole", "defaultSeerScannerAutomation", "enableSeerCoding", "enhancedPrivacy", "eventsMemberAdmin", "experiments", "hasAuthProvider", "hideAiFeatures", "id", "isDefault", "isDynamicallySampled", "isEarlyAdopter", "issueAlertsThreadFlag", "links", "metricAlertsThreadFlag", "name", "openMembership", "orgRoleList", "pendingAccessRequests", "projects", "relayPiiConfig", "require2FA", "requiresSso", "safeFields", "scrapeJavaScript", "scrubIPAddresses", "sensitiveFields", "slug", "status", "storeCrashReports", "teamRoleList", "teams", "trustedRelays" ] }, "OutcomesResponse": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "intervals": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "by": { "type": "object", "additionalProperties": {} }, "totals": { "type": "object", "additionalProperties": {} }, "series": { "type": "object", "additionalProperties": {} } }, "required": [ "by", "series", "totals" ] } } }, "required": [ "end", "groups", "intervals", "start" ] }, "OutgoingNotificationAction": { "type": "object", "additionalProperties": {} }, "PageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "ProjectAdmin": { "type": "object", "properties": { "isBookmarked": { "type": "boolean", "description": "Enables starring the project within the projects tab. Can be updated with **`project:read`** permission." }, "name": { "type": "string", "description": "The name for the project", "maxLength": 200 }, "slug": { "type": "string", "description": "Uniquely identifies a project and is used for the interface.", "maxLength": 100, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "platform": { "type": "string", "nullable": true, "description": "The platform for the project" }, "subjectPrefix": { "type": "string", "description": "Custom prefix for emails from this project.", "maxLength": 200 }, "subjectTemplate": { "type": "string", "description": "The email subject to use (excluding the prefix) for individual alerts. Here are the list of variables you can use:\n- `$title`\n- `$shortID`\n- `$projectID`\n- `$orgID`\n- `${tag:key}` - such as `${tag:environment}` or `${tag:release}`.", "maxLength": 200 }, "resolveAge": { "type": "integer", "nullable": true, "description": "Automatically resolve an issue if it hasn't been seen for this many hours. Set to `0` to disable auto-resolve." }, "highlightContext": { "type": "object", "additionalProperties": {}, "description": "A JSON mapping of context types to lists of strings for their keys.\nE.g. `{'user': ['id', 'email']}`" }, "highlightTags": { "type": "array", "items": { "type": "string" }, "description": "A list of strings with tag keys to highlight on this project's issues.\nE.g. `['release', 'environment']`" }, "scmSourceContextEnabled": { "type": "boolean", "description": "Enable on-demand source context fetching from SCM integrations for stack traces." } } }, "ProjectEventsResponseDict": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "event.type": { "type": "string" }, "groupID": { "type": "string", "nullable": true }, "eventID": { "type": "string" }, "projectID": { "type": "string" }, "message": { "type": "string" }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "culprit": { "type": "string", "nullable": true }, "user": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "ip_address": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "geo": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "nullable": true }, "tags": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "crashFile": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "crashFile", "culprit", "dateCreated", "event.type", "eventID", "groupID", "id", "location", "message", "metadata", "platform", "projectID", "tags", "title", "user" ] } }, "ProjectFilterResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "active", "id" ] } }, "ProjectKey": { "type": "object", "description": "This represents a Sentry Project Client Key.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "public": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "projectId": { "type": "integer" }, "isActive": { "type": "boolean" }, "rateLimit": { "type": "object", "properties": { "window": { "type": "integer" }, "count": { "type": "integer" } }, "required": [ "count", "window" ], "nullable": true }, "dsn": { "type": "object", "properties": { "secret": { "type": "string" }, "public": { "type": "string" }, "csp": { "type": "string" }, "security": { "type": "string" }, "minidump": { "type": "string" }, "nel": { "type": "string" }, "unreal": { "type": "string" }, "crons": { "type": "string" }, "cdn": { "type": "string" }, "playstation": { "type": "string" }, "integration": { "type": "string" }, "otlp_traces": { "type": "string" }, "otlp_logs": { "type": "string" } }, "required": [ "cdn", "crons", "csp", "integration", "minidump", "nel", "otlp_logs", "otlp_traces", "playstation", "public", "secret", "security", "unreal" ] }, "browserSdkVersion": { "type": "string" }, "browserSdk": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "choices" ] }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "dynamicSdkLoaderOptions": { "type": "object", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } }, "required": [ "hasDebug", "hasFeedback", "hasLogsAndMetrics", "hasPerformance", "hasReplay" ] }, "useCase": { "type": "string" } }, "required": [ "browserSdk", "browserSdkVersion", "dateCreated", "dsn", "dynamicSdkLoaderOptions", "id", "isActive", "label", "name", "projectId", "public", "rateLimit", "secret" ] }, "ProjectKeyPost": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "The optional name of the key. If not provided it will be automatically generated.", "maxLength": 64 }, "rateLimit": { "type": "object", "description": "Applies a rate limit to cap the number of errors accepted during a given time window. To\ndisable entirely set `rateLimit` to null.\n```json\n{\n \"rateLimit\": {\n \"window\": 7200, // time in seconds\n \"count\": 1000 // error cap\n }\n}\n```", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "window": { "type": "integer", "maximum": 86400, "minimum": 0, "nullable": true } } }, "useCase": { "enum": [ "user", "profiling", "tempest", "demo" ], "type": "string", "description": "* `user`\n* `profiling`\n* `tempest`\n* `demo`", "default": "user" } } }, "ProjectOwnership": { "type": "object", "properties": { "schema": { "type": "object", "properties": { "$version": { "type": "integer" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "matcher": { "type": "object", "properties": { "type": { "type": "string" }, "pattern": { "type": "string" } }, "required": [ "pattern", "type" ] }, "owners": { "type": "array", "items": { "type": "object", "description": "Owner as it appears in the API response (after identifier->name rename).", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "name", "type" ] } } }, "required": [ "matcher", "owners" ] } } }, "required": [ "$version", "rules" ], "nullable": true }, "raw": { "type": "string" }, "fallthrough": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "autoAssignment": { "type": "string" }, "codeownersAutoSync": { "type": "boolean" } }, "required": [ "autoAssignment", "codeownersAutoSync", "dateCreated", "fallthrough", "isActive", "lastUpdated", "raw" ] }, "ProjectOwnershipRequest": { "type": "object", "properties": { "raw": { "type": "string", "description": "Raw input for ownership configuration. See the [Ownership Rules Documentation](/product/issues/ownership-rules/) to learn more." }, "fallthrough": { "type": "boolean", "description": "A boolean determining who to assign ownership to when an ownership rule has no match. If set to `True`, all project members are made owners. Otherwise, no owners are set." }, "autoAssignment": { "type": "string", "description": "Auto-assignment settings. The available options are:\n- Auto Assign to Issue Owner\n- Auto Assign to Suspect Commits\n- Turn off Auto-Assignment" }, "codeownersAutoSync": { "type": "boolean", "default": true, "description": "Set to `True` to sync issue owners with CODEOWNERS updates in a release." } } }, "ProjectPost": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for the project.", "maxLength": 50 }, "slug": { "type": "string", "nullable": true, "description": "Uniquely identifies a project and is used for the interface.\n If not provided, it is automatically generated from the name.", "maxLength": 100, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "platform": { "type": "string", "nullable": true, "description": "The platform for the project." }, "default_rules": { "type": "boolean", "description": "\nDefaults to true where the behavior is to alert the user on every new\nissue. Setting this to false will turn this off and the user must create\ntheir own alerts to be notified of new issues.\n " } }, "required": [ "name" ] }, "ProjectSizeStatusCheckRulesResponse": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "metric": { "enum": [ "install_size", "download_size" ], "type": "string" }, "measurement": { "enum": [ "absolute", "absolute_diff", "relative_diff" ], "type": "string" }, "value": { "type": "string" }, "filterQuery": { "type": "string" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "enum": [ "app_id", "build_configuration_name", "git_head_ref", "platform_name" ], "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "operator": { "enum": [ "contains", "endsWith", "equals", "in", "matches", "notContains", "notEndsWith", "notEquals", "notIn", "notMatches", "notStartsWith", "startsWith" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "operator", "values" ] } } }, "required": [ "conditions", "key" ] }, "nullable": true }, "artifactType": { "enum": [ "main_artifact", "watch_artifact", "android_dynamic_feature_artifact", "app_clip_artifact", "all_artifacts" ], "type": "string" } }, "required": [ "artifactType", "filterQuery", "filters", "id", "measurement", "metric", "value" ] } } }, "required": [ "enabled", "rules" ] }, "ProjectSummary": { "type": "object", "properties": { "latestDeploys": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "options": { "type": "object", "additionalProperties": {} }, "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "nullable": true }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } }, "platforms": { "type": "array", "items": { "type": "string" } }, "hasUserReports": { "type": "boolean" }, "environments": { "type": "array", "items": { "type": "string" } }, "latestRelease": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ], "nullable": true } }, "required": [ "access", "dateCreated", "environments", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "hasUserReports", "id", "isBookmarked", "isMember", "latestRelease", "name", "platform", "platforms", "slug", "team", "teams" ] }, "ProjectTeamsResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] } }, "ProjectWithTeam": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] } } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status", "teams" ] }, "RateLimit": { "type": "object", "description": "Applies a rate limit to cap the number of errors accepted during a given time window. To\ndisable entirely set `rateLimit` to null.\n```json\n{\n \"rateLimit\": {\n \"window\": 7200, // time in seconds\n \"count\": 1000 // error cap\n }\n}\n```", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "window": { "type": "integer", "maximum": 86400, "minimum": 0, "nullable": true } } }, "ReleaseHeadCommit": { "type": "object", "properties": { "commit": { "type": "string" }, "repository": { "type": "string", "maxLength": 200 }, "previousCommit": { "type": "string", "nullable": true, "maxLength": 64 } }, "required": [ "commit", "repository" ] }, "ReleaseThresholdStatusResponse": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "environment": { "type": "object", "additionalProperties": {}, "nullable": true }, "project": { "type": "object", "additionalProperties": {} }, "release": { "type": "string" }, "threshold_type": { "type": "integer" }, "trigger_type": { "type": "string" }, "value": { "type": "integer" }, "window_in_seconds": { "type": "integer" }, "end": { "type": "string", "format": "date-time" }, "is_healthy": { "type": "boolean" }, "key": { "type": "string" }, "project_slug": { "type": "string" }, "project_id": { "type": "integer" }, "start": { "type": "string", "format": "date-time" }, "metric_value": { "anyOf": [ { "type": "integer" }, { "type": "number", "format": "double" }, { "type": "object", "nullable": true } ] } }, "required": [ "end", "is_healthy", "key", "metric_value", "project_id", "project_slug", "start" ] } } }, "ReplayCounts": { "type": "object", "additionalProperties": { "type": "integer" } }, "ReplayDeletionJobCreate": { "type": "object", "properties": { "data": { "type": "object", "properties": { "rangeStart": { "type": "string", "format": "date-time" }, "rangeEnd": { "type": "string", "format": "date-time" }, "environments": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string", "nullable": true } }, "required": [ "environments", "query", "rangeEnd", "rangeStart" ] } }, "required": [ "data" ] }, "ReplayDeletionJobCreateData": { "type": "object", "properties": { "rangeStart": { "type": "string", "format": "date-time" }, "rangeEnd": { "type": "string", "format": "date-time" }, "environments": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string", "nullable": true } }, "required": [ "environments", "query", "rangeEnd", "rangeStart" ] }, "Repositories": { "type": "object", "description": "Serializer for repositories response", "properties": { "results": { "type": "array", "items": { "type": "object", "description": "Serializer for individual repository nodes from GraphQL response", "properties": { "name": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "latestCommitAt": { "type": "string", "format": "date-time" }, "defaultBranch": { "type": "string" } }, "required": [ "defaultBranch", "latestCommitAt", "name", "updatedAt" ] } }, "pageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "totalCount": { "type": "integer" } }, "required": [ "pageInfo", "results", "totalCount" ] }, "Repository": { "type": "object", "description": "Serializer for single repository response", "properties": { "uploadToken": { "type": "string", "nullable": true }, "testAnalyticsEnabled": { "type": "boolean" } }, "required": [ "testAnalyticsEnabled", "uploadToken" ] }, "RepositoryNode": { "type": "object", "description": "Serializer for individual repository nodes from GraphQL response", "properties": { "name": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "latestCommitAt": { "type": "string", "format": "date-time" }, "defaultBranch": { "type": "string" } }, "required": [ "defaultBranch", "latestCommitAt", "name", "updatedAt" ] }, "RepositoryTokenNode": { "type": "object", "description": "Serializer for individual repository nodes from GraphQL response", "properties": { "name": { "type": "string" }, "token": { "type": "string" } }, "required": [ "name", "token" ] }, "RepositoryTokenRegenerate": { "type": "object", "description": "Serializer for repositories response", "properties": { "token": { "type": "string" } }, "required": [ "token" ] }, "RepositoryTokens": { "type": "object", "description": "Serializer for repository tokens response", "properties": { "results": { "type": "array", "items": { "type": "object", "description": "Serializer for individual repository nodes from GraphQL response", "properties": { "name": { "type": "string" }, "token": { "type": "string" } }, "required": [ "name", "token" ] } }, "pageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "totalCount": { "type": "integer" } }, "required": [ "pageInfo", "results", "totalCount" ] }, "SCIMListResponseEnvelopeSCIMMemberIndexResponse": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "Resources": { "type": "array", "items": { "type": "object", "description": "Conforming to the SCIM RFC, this represents a Sentry Org Member\nas a SCIM user object.", "properties": { "active": { "type": "boolean" }, "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "userName": { "type": "string" }, "name": { "type": "object", "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } }, "required": [ "familyName", "givenName" ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "primary": { "type": "boolean" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "primary", "type", "value" ] } }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "sentryOrgRole": { "type": "string" } }, "required": [ "emails", "id", "meta", "name", "schemas", "sentryOrgRole", "userName" ] } } }, "required": [ "Resources", "itemsPerPage", "schemas", "startIndex", "totalResults" ] }, "SCIMListResponseEnvelopeSCIMTeamIndexResponse": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "totalResults": { "type": "integer" }, "startIndex": { "type": "integer" }, "itemsPerPage": { "type": "integer" }, "Resources": { "type": "array", "items": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "displayName": { "type": "string" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "display": { "type": "string" } }, "required": [ "display", "value" ] } } }, "required": [ "displayName", "id", "meta", "schemas" ] } } }, "required": [ "Resources", "itemsPerPage", "schemas", "startIndex", "totalResults" ] }, "SCIMMemberProvision": { "type": "object", "properties": { "userName": { "type": "string", "format": "email", "description": "The SAML field used for email." }, "sentryOrgRole": { "enum": [ "billing", "member", "manager", "admin" ], "type": "string", "description": "The organization role of the member. If unspecified, this will be\n set to the organization's default role. The options are:\n\n* `billing` - Can manage payment and compliance details.\n* `member` - Can view and act on events, as well as view most other data within the organization.\n* `manager` - Has full management access to all teams and projects. Can also manage\n the organization's membership.\n* `admin` - Can edit global integrations, manage projects, and add/remove teams.\n They automatically assume the Team Admin role for teams they join.\n Note: This role can no longer be assigned in Business and Enterprise plans. Use `TeamRoles` instead.\n " } }, "required": [ "userName" ] }, "SCIMPatchOperation": { "type": "object", "properties": { "op": { "type": "string" }, "value": {}, "path": { "type": "string" } }, "required": [ "op", "value" ] }, "SCIMPatchRequest": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string" }, "value": {}, "path": { "type": "string" } }, "required": [ "op", "value" ] }, "description": "A list of operations to perform. Currently, the only valid operation is setting\na member's `active` attribute to false, after which the member will be permanently deleted.\n```json\n{\n \"Operations\": [{\n \"op\": \"replace\",\n \"path\": \"active\",\n \"value\": False\n }]\n}\n```\n", "maxItems": 100 } }, "required": [ "Operations" ] }, "SCIMTeamPatchOperation": { "type": "object", "properties": { "op": { "type": "string" }, "value": { "type": "object", "additionalProperties": {} }, "path": { "type": "string" } }, "required": [ "op" ] }, "SCIMTeamPatchRequest": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string" }, "value": { "type": "object", "additionalProperties": {} }, "path": { "type": "string" } }, "required": [ "op" ] }, "description": "The list of operations to perform. Valid operations are:\n* Renaming a team:\n```json\n{\n \"Operations\": [{\n \"op\": \"replace\",\n \"value\": {\n \"id\": 23,\n \"displayName\": \"newName\"\n }\n }]\n}\n```\n* Adding a member to a team:\n```json\n{\n \"Operations\": [{\n \"op\": \"add\",\n \"path\": \"members\",\n \"value\": [\n {\n \"value\": 23,\n \"display\": \"testexample@example.com\"\n }\n ]\n }]\n}\n```\n* Removing a member from a team:\n```json\n{\n \"Operations\": [{\n \"op\": \"remove\",\n \"path\": \"members[value eq \"23\"]\"\n }]\n}\n```\n* Replacing an entire member set of a team:\n```json\n{\n \"Operations\": [{\n \"op\": \"replace\",\n \"path\": \"members\",\n \"value\": [\n {\n \"value\": 23,\n \"display\": \"testexample2@sentry.io\"\n },\n {\n \"value\": 24,\n \"display\": \"testexample3@sentry.io\"\n }\n ]\n }]\n}\n```\n" } }, "required": [ "Operations" ] }, "SCIMTeamRequestBody": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The slug of the team that is shown in the UI." } }, "required": [ "displayName" ] }, "SeerModelsResponse": { "type": "object", "description": "Response containing list of actively used LLM model names from Seer.", "properties": { "models": { "type": "array", "items": { "type": "string" } } }, "required": [ "models" ] }, "SentryAppDetailsResponse": { "type": "object", "properties": { "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "avatars": { "type": "array", "items": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string" }, "avatarUrl": { "type": "string" }, "color": { "type": "boolean" }, "photoType": { "type": "string" } }, "required": [ "avatarType", "avatarUrl", "avatarUuid", "color", "photoType" ] } }, "events": { "type": "array", "items": { "type": "string" } }, "featureData": { "type": "array", "items": { "type": "string" } }, "isAlertable": { "type": "boolean" }, "metadata": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string" }, "status": { "type": "string" }, "uuid": { "type": "string" }, "verifyInstall": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "author": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "popularity": { "type": "integer", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true }, "webhookUrl": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "datePublished": { "type": "string", "format": "date-time" }, "clientId": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" } }, "required": [ "id", "slug" ] } }, "required": [ "allowedOrigins", "avatars", "events", "featureData", "isAlertable", "metadata", "name", "schema", "scopes", "slug", "status", "uuid", "verifyInstall" ] }, "SentryAppParser": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom integration." }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The custom integration's permission scopes for API access." }, "author": { "type": "string", "nullable": true, "description": "The custom integration's author." }, "events": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Webhook events the custom integration is subscribed to." }, "schema": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "The UI components schema, used to render the custom integration's configuration UI elements. See our [schema docs](https://docs.sentry.io/organization/integrations/integration-platform/ui-components/) for more information." }, "webhookUrl": { "type": "string", "format": "uri", "nullable": true, "description": "The webhook destination URL." }, "redirectUrl": { "type": "string", "format": "uri", "nullable": true, "description": "The post-installation redirect URL." }, "isInternal": { "type": "boolean", "default": false, "description": "Whether or not the integration is internal only. False means the integration is public." }, "isAlertable": { "type": "boolean", "default": false, "description": "Marks whether or not the custom integration can be used in an alert rule." }, "overview": { "type": "string", "nullable": true, "description": "The custom integration's description." }, "verifyInstall": { "type": "boolean", "default": true, "description": "Whether or not an installation of the custom integration should be verified." }, "allowedOrigins": { "type": "array", "items": { "type": "string", "maxLength": 255 }, "description": "The list of allowed origins for CORS." } }, "required": [ "name", "scopes" ] }, "SessionsQueryResult": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "intervals": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "by": { "type": "object", "properties": { "project": { "type": "integer" }, "release": { "type": "string" }, "environment": { "type": "string" }, "session.status": { "type": "string" } } }, "series": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "number", "format": "double", "nullable": true } } }, "totals": { "type": "object", "additionalProperties": { "type": "number", "format": "double", "nullable": true } } }, "required": [ "by", "series", "totals" ] } }, "query": { "type": "string" } }, "required": [ "end", "groups", "intervals", "query", "start" ] }, "ShortIdLookupResponse": { "type": "object", "properties": { "organizationSlug": { "type": "string" }, "projectSlug": { "type": "string" }, "groupId": { "type": "string" }, "group": { "type": "object", "properties": { "isUnhandled": { "type": "boolean" }, "count": { "type": "string" }, "userCount": { "type": "integer" }, "firstSeen": { "type": "string", "format": "date-time", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string" }, "shareId": { "type": "string" }, "shortId": { "type": "string" }, "title": { "type": "string" }, "culprit": { "type": "string", "nullable": true }, "permalink": { "type": "string" }, "logger": { "type": "string", "nullable": true }, "level": { "type": "string" }, "status": { "type": "string" }, "statusDetails": { "type": "object", "properties": { "autoResolved": { "type": "boolean" }, "ignoreCount": { "type": "integer" }, "ignoreUntil": { "type": "string", "format": "date-time" }, "ignoreUserCount": { "type": "integer" }, "ignoreUserWindow": { "type": "integer" }, "ignoreWindow": { "type": "integer" }, "actor": { "type": "object", "properties": { "identities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "slug" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "dateVerified": { "type": "string", "format": "date-time" }, "dateSynced": { "type": "string", "format": "date-time" } }, "required": [ "dateSynced", "dateVerified", "id", "name", "organization", "provider" ] } }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "authenticators": { "type": "array", "items": {} }, "canReset2fa": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "avatarUrl": { "type": "string" }, "isActive": { "type": "boolean" }, "isSuspended": { "type": "boolean" }, "hasPasswordAuth": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "dateJoined": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "has2fa": { "type": "boolean" }, "lastActive": { "type": "string", "format": "date-time", "nullable": true }, "isSuperuser": { "type": "boolean" }, "isStaff": { "type": "boolean" }, "experiments": { "type": "object", "additionalProperties": {} }, "emails": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_verified": { "type": "boolean" } }, "required": [ "email", "id", "is_verified" ] } } }, "required": [ "avatarUrl", "dateJoined", "email", "emails", "experiments", "has2fa", "hasPasswordAuth", "id", "isActive", "isManaged", "isStaff", "isSuperuser", "isSuspended", "lastActive", "lastLogin", "name", "username" ] }, "inNextRelease": { "type": "boolean" }, "inRelease": { "type": "string" }, "inCommit": { "type": "string" }, "pendingEvents": { "type": "integer" }, "info": {} } }, "substatus": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" }, "platform": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "priorityLockedAt": { "type": "string", "format": "date-time", "nullable": true }, "seerFixabilityScore": { "type": "number", "format": "double", "nullable": true }, "seerAutofixLastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "seerExplorerAutofixLastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "project": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "platform": { "type": "string", "nullable": true } }, "required": [ "id", "name", "platform", "slug" ] }, "type": { "type": "string" }, "issueType": { "type": "string" }, "issueCategory": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} }, "numComments": { "type": "integer" }, "assignedTo": { "type": "object", "properties": { "type": { "enum": [ "user", "team" ], "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "type" ] }, "isBookmarked": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "subscriptionDetails": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "reason": { "type": "string" } }, "nullable": true }, "hasSeen": { "type": "boolean" }, "annotations": { "type": "array", "items": { "type": "object", "properties": { "displayName": { "type": "string" }, "url": { "type": "string" } }, "required": [ "displayName", "url" ] } } }, "required": [ "annotations", "assignedTo", "culprit", "hasSeen", "id", "isBookmarked", "isPublic", "isSubscribed", "issueCategory", "issueType", "level", "logger", "metadata", "numComments", "permalink", "platform", "priority", "priorityLockedAt", "project", "seerAutofixLastTriggered", "seerExplorerAutofixLastTriggered", "seerFixabilityScore", "shareId", "shortId", "status", "statusDetails", "subscriptionDetails", "substatus", "title", "type" ] }, "shortId": { "type": "string" } }, "required": [ "group", "groupId", "organizationSlug", "projectSlug", "shortId" ] }, "SizeAnalysisResponse": { "type": "object", "properties": { "buildId": { "type": "string" }, "state": { "type": "string" }, "appInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ] }, "gitInfo": { "type": "object", "properties": { "headSha": { "type": "string", "nullable": true }, "baseSha": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "headRepoName": { "type": "string", "nullable": true }, "baseRepoName": { "type": "string", "nullable": true }, "headRef": { "type": "string", "nullable": true }, "baseRef": { "type": "string", "nullable": true }, "prNumber": { "type": "integer", "nullable": true } }, "required": [ "baseRef", "baseRepoName", "baseSha", "headRef", "headRepoName", "headSha", "prNumber", "provider" ], "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "downloadSize": { "type": "integer", "nullable": true }, "installSize": { "type": "integer", "nullable": true }, "analysisDuration": { "type": "number", "format": "double", "nullable": true }, "analysisVersion": { "type": "string", "nullable": true }, "baseBuildId": { "type": "string", "nullable": true }, "baseAppInfo": { "type": "object", "properties": { "appId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "buildNumber": { "type": "integer", "nullable": true }, "artifactType": { "type": "string", "nullable": true }, "dateAdded": { "type": "string", "nullable": true }, "dateBuilt": { "type": "string", "nullable": true } }, "required": [ "appId", "artifactType", "buildNumber", "dateAdded", "dateBuilt", "name", "version" ], "nullable": true }, "insights": { "type": "object", "additionalProperties": {}, "nullable": true }, "appComponents": { "type": "array", "items": { "type": "object", "properties": { "componentType": { "type": "string" }, "name": { "type": "string" }, "appId": { "type": "string" }, "path": { "type": "string" }, "downloadSize": { "type": "integer" }, "installSize": { "type": "integer" } }, "required": [ "appId", "componentType", "downloadSize", "installSize", "name", "path" ] }, "nullable": true }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "metricsArtifactType": { "type": "string" }, "identifier": { "type": "string", "nullable": true }, "state": { "type": "string" }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "sizeMetricDiff": { "type": "object", "properties": { "metricsArtifactType": { "type": "string" }, "identifier": { "type": "string", "nullable": true }, "headInstallSize": { "type": "integer" }, "headDownloadSize": { "type": "integer" }, "baseInstallSize": { "type": "integer" }, "baseDownloadSize": { "type": "integer" } }, "required": [ "baseDownloadSize", "baseInstallSize", "headDownloadSize", "headInstallSize", "identifier", "metricsArtifactType" ], "nullable": true }, "diffItems": { "type": "array", "items": { "type": "object", "properties": { "sizeDiff": { "type": "integer" }, "headSize": { "type": "integer", "nullable": true }, "baseSize": { "type": "integer", "nullable": true }, "path": { "type": "string" }, "itemType": { "type": "string", "nullable": true }, "type": { "type": "string" }, "diffItems": { "type": "array", "items": {}, "nullable": true } }, "required": [ "baseSize", "diffItems", "headSize", "itemType", "path", "sizeDiff", "type" ] }, "nullable": true }, "insightDiffItems": { "type": "array", "items": { "type": "object", "properties": { "insightType": { "type": "string" }, "status": { "type": "string" }, "totalSavingsChange": { "type": "integer" }, "fileDiffs": { "type": "array", "items": { "type": "object", "properties": { "sizeDiff": { "type": "integer" }, "headSize": { "type": "integer", "nullable": true }, "baseSize": { "type": "integer", "nullable": true }, "path": { "type": "string" }, "itemType": { "type": "string", "nullable": true }, "type": { "type": "string" }, "diffItems": { "type": "array", "items": {}, "nullable": true } }, "required": [ "baseSize", "diffItems", "headSize", "itemType", "path", "sizeDiff", "type" ] } }, "groupDiffs": { "type": "array", "items": { "type": "object", "properties": { "sizeDiff": { "type": "integer" }, "headSize": { "type": "integer", "nullable": true }, "baseSize": { "type": "integer", "nullable": true }, "path": { "type": "string" }, "itemType": { "type": "string", "nullable": true }, "type": { "type": "string" }, "diffItems": { "type": "array", "items": {}, "nullable": true } }, "required": [ "baseSize", "diffItems", "headSize", "itemType", "path", "sizeDiff", "type" ] } } }, "required": [ "fileDiffs", "groupDiffs", "insightType", "status", "totalSavingsChange" ] }, "nullable": true } }, "required": [ "diffItems", "errorCode", "errorMessage", "identifier", "insightDiffItems", "metricsArtifactType", "sizeMetricDiff", "state" ] }, "nullable": true } }, "required": [ "analysisDuration", "analysisVersion", "appComponents", "appInfo", "baseAppInfo", "baseBuildId", "buildId", "comparisons", "downloadSize", "errorCode", "errorMessage", "gitInfo", "insights", "installSize", "state" ] }, "Source": { "type": "object", "properties": { "type": { "enum": [ "http", "gcs", "s3" ], "type": "string", "description": "The type of the source.\n\n* `http` - SymbolServer (HTTP)\n* `gcs` - Google Cloud Storage\n* `s3` - Amazon S3" }, "name": { "type": "string", "description": "The human-readable name of the source." }, "id": { "type": "string", "description": "The internal ID of the source. Must be distinct from all other source IDs and cannot start with '`sentry:`'. If this is not provided, a new UUID will be generated." }, "layout": { "type": "object", "description": "Layout settings for the source. This is required for HTTP, GCS, and S3 sources.\n\n**`type`** ***(string)*** - The layout of the folder structure. The options are:\n- `native` - Platform-Specific (SymStore / GDB / LLVM)\n- `symstore` - Microsoft SymStore\n- `symstore_index2` - Microsoft SymStore (with index2.txt)\n- `ssqp` - Microsoft SSQP\n- `unified` - Unified Symbol Server Layout\n- `debuginfod` - debuginfod\n\n**`casing`** ***(string)*** - The layout of the folder structure. The options are:\n- `default` - Default (mixed case)\n- `uppercase` - Uppercase\n- `lowercase` - Lowercase\n\n```json\n{\n \"layout\": {\n \"type\": \"native\"\n \"casing\": \"default\"\n }\n}\n```", "properties": { "type": { "enum": [ "native", "symstore", "symstore_index2", "ssqp", "unified", "debuginfod", "slashsymbols" ], "type": "string", "description": "The source's layout type.\n\n* `native`\n* `symstore`\n* `symstore_index2`\n* `ssqp`\n* `unified`\n* `debuginfod`\n* `slashsymbols`" }, "casing": { "enum": [ "lowercase", "uppercase", "default" ], "type": "string", "description": "The source's casing rules.\n\n* `lowercase`\n* `uppercase`\n* `default`" } }, "required": [ "casing", "type" ] }, "filters": { "type": "object", "description": "Filter settings for the source. This is optional for all sources.\n\n**`filetypes`** ***(list)*** - A list of file types that can be found on this source. If this is left empty, all file types will be enabled. The options are:\n- `pe` - Windows executable files\n- `pdb` - Windows debug files\n- `portablepdb` - .NET portable debug files\n- `mach_code` - MacOS executable files\n- `mach_debug` - MacOS debug files\n- `elf_code` - ELF executable files\n- `elf_debug` - ELF debug files\n- `wasm_code` - WASM executable files\n- `wasm_debug` - WASM debug files\n- `breakpad` - Breakpad symbol files\n- `sourcebundle` - Source code bundles\n- `uuidmap` - Apple UUID mapping files\n- `bcsymbolmap` - Apple bitcode symbol maps\n- `il2cpp` - Unity IL2CPP mapping files\n- `proguard` - ProGuard mapping files\n\n**`path_patterns`** ***(list)*** - A list of glob patterns to check against the debug and code file paths of debug files. Only files that match one of these patterns will be requested from the source. If this is left empty, no path-based filtering takes place.\n\n**`requires_checksum`** ***(boolean)*** - Whether this source requires a debug checksum to be sent with each request. Defaults to `false`.\n\n```json\n{\n \"filters\": {\n \"filetypes\": [\"pe\", \"pdb\", \"portablepdb\"],\n \"path_patterns\": [\"*ffmpeg*\"]\n }\n}\n```", "properties": { "filetypes": { "type": "array", "items": { "enum": [ "pe", "pdb", "portablepdb", "mach_debug", "mach_code", "elf_debug", "elf_code", "wasm_debug", "wasm_code", "breakpad", "sourcebundle", "uuidmap", "bcsymbolmap", "il2cpp", "proguard", "dartsymbolmap" ], "type": "string", "description": "* `pe`\n* `pdb`\n* `portablepdb`\n* `mach_debug`\n* `mach_code`\n* `elf_debug`\n* `elf_code`\n* `wasm_debug`\n* `wasm_code`\n* `breakpad`\n* `sourcebundle`\n* `uuidmap`\n* `bcsymbolmap`\n* `il2cpp`\n* `proguard`\n* `dartsymbolmap`" }, "description": "The file types enabled for the source." }, "path_patterns": { "type": "array", "items": { "type": "string" }, "description": "The debug and code file paths enabled for the source." }, "requires_checksum": { "type": "boolean", "description": "Whether the source requires debug checksums." } } }, "url": { "type": "string", "description": "The source's URL. Optional for HTTP sources, invalid for all others." }, "username": { "type": "string", "description": "The user name for accessing the source. Optional for HTTP sources, invalid for all others." }, "password": { "type": "string", "description": "The password for accessing the source. Optional for HTTP sources, invalid for all others." }, "bucket": { "type": "string", "description": "The GCS or S3 bucket where the source resides. Required for GCS and S3 source, invalid for HTTP sources." }, "region": { "enum": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-east-1", "ap-south-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-north-1", "sa-east-1", "us-gov-east-1", "us-gov-west-1" ], "type": "string", "description": "The source's [S3 region](https://docs.aws.amazon.com/general/latest/gr/s3.html). Required for S3 sources, invalid for all others.\n\n* `us-east-2` - US East (Ohio)\n* `us-east-1` - US East (N. Virginia)\n* `us-west-1` - US West (N. California)\n* `us-west-2` - US West (Oregon)\n* `ap-east-1` - Asia Pacific (Hong Kong)\n* `ap-south-1` - Asia Pacific (Mumbai)\n* `ap-northeast-2` - Asia Pacific (Seoul)\n* `ap-southeast-1` - Asia Pacific (Singapore)\n* `ap-southeast-2` - Asia Pacific (Sydney)\n* `ap-northeast-1` - Asia Pacific (Tokyo)\n* `ca-central-1` - Canada (Central)\n* `cn-north-1` - China (Beijing)\n* `cn-northwest-1` - China (Ningxia)\n* `eu-central-1` - EU (Frankfurt)\n* `eu-west-1` - EU (Ireland)\n* `eu-west-2` - EU (London)\n* `eu-west-3` - EU (Paris)\n* `eu-north-1` - EU (Stockholm)\n* `sa-east-1` - South America (São Paulo)\n* `us-gov-east-1` - AWS GovCloud (US-East)\n* `us-gov-west-1` - AWS GovCloud (US)" }, "access_key": { "type": "string", "description": "The [AWS Access Key](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html#access-keys-and-secret-access-keys).Required for S3 sources, invalid for all others." }, "secret_key": { "type": "string", "description": "The [AWS Secret Access Key](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html#access-keys-and-secret-access-keys).Required for S3 sources, invalid for all others." }, "prefix": { "type": "string", "description": "The GCS or [S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) prefix. Optional for GCS and S3 sourcse, invalid for HTTP." }, "client_email": { "type": "string", "description": "The GCS email address for authentication. Required for GCS sources, invalid for all others." }, "private_key": { "type": "string", "description": "The GCS private key. Required for GCS sources if not using impersonated tokens. Invalid for all others." } }, "required": [ "name", "type" ] }, "SourceMapDebug": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "data", "message", "type" ] } } }, "required": [ "errors" ] }, "StatusDetailsValidator": { "type": "object", "properties": { "inNextRelease": { "type": "boolean", "description": "If true, marks the issue as resolved in the next release." }, "inRelease": { "type": "string", "description": "The version of the release that the issue should be resolved in.If set to `latest`, the latest release will be used." }, "inCommit": { "allOf": [ { "type": "object", "properties": { "commit": { "type": "string", "description": "The SHA of the resolving commit." }, "repository": { "type": "string", "description": "The name of the repository (as it appears in Sentry)." } }, "required": [ "commit", "repository" ] } ], "description": "The commit data that the issue should use for resolution." }, "ignoreDuration": { "type": "integer", "description": "Ignore the issue until for this many minutes." }, "ignoreCount": { "type": "integer", "description": "Ignore the issue until it has occurred this many times in `ignoreWindow` minutes." }, "ignoreWindow": { "type": "integer", "maximum": 10080, "description": "Ignore the issue until it has occurred `ignoreCount` times in this many minutes. (Max: 1 week)" }, "ignoreUserCount": { "type": "integer", "description": "Ignore the issue until it has affected this many users in `ignoreUserWindow` minutes." }, "ignoreUserWindow": { "type": "integer", "maximum": 10080, "description": "Ignore the issue until it has affected `ignoreUserCount` users in this many minutes. (Max: 1 week)" } }, "required": [ "ignoreCount", "ignoreDuration", "ignoreUserCount", "ignoreUserWindow", "ignoreWindow", "inNextRelease", "inRelease" ] }, "SyncRepos": { "type": "object", "description": "Serializer for a sync repository response", "properties": { "isSyncing": { "type": "boolean" } }, "required": [ "isSyncing" ] }, "TagKeyDetailsDict": { "type": "object", "properties": { "uniqueValues": { "type": "integer", "nullable": true }, "totalValues": { "type": "integer", "nullable": true }, "topValues": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "key": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string", "nullable": true }, "count": { "type": "integer", "nullable": true }, "lastSeen": { "type": "string", "nullable": true }, "firstSeen": { "type": "string", "nullable": true } }, "required": [ "count", "firstSeen", "key", "lastSeen", "name", "value" ] }, "nullable": true }, "key": { "type": "string" }, "name": { "type": "string" } }, "required": [ "key", "name" ] }, "TagKeyValuesDict": { "type": "array", "items": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "key": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string", "nullable": true }, "count": { "type": "integer", "nullable": true }, "lastSeen": { "type": "string", "nullable": true }, "firstSeen": { "type": "string", "nullable": true } }, "required": [ "count", "firstSeen", "key", "lastSeen", "name", "value" ] } }, "Team": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time", "nullable": true }, "isMember": { "type": "boolean" }, "teamRole": { "type": "string", "nullable": true }, "flags": { "type": "object", "additionalProperties": {} }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "isPending": { "type": "boolean" }, "memberCount": { "type": "integer" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "externalTeams": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "externalName": { "type": "string" }, "integrationId": { "type": "string" } }, "required": [ "externalName", "id", "integrationId", "provider" ] } }, "organization": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } }, "extraOptions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "access": { "type": "array", "items": { "type": "string" } }, "onboardingTasks": { "type": "array", "items": { "type": "object", "properties": { "task": { "type": "string", "nullable": true }, "status": { "type": "string" }, "completionSeen": { "type": "string", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "format": "date-time" }, "data": {} }, "required": [ "completionSeen", "data", "dateCompleted", "status", "task" ] } }, "id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "name": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "isEarlyAdopter": { "type": "boolean" }, "require2FA": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "links": { "type": "object", "properties": { "organizationUrl": { "type": "string" }, "regionUrl": { "type": "string" } }, "required": [ "organizationUrl", "regionUrl" ] }, "hasAuthProvider": { "type": "boolean" }, "allowMemberInvite": { "type": "boolean" }, "allowMemberProjectCreation": { "type": "boolean" }, "allowSuperuserAccess": { "type": "boolean" } }, "required": [ "allowMemberInvite", "allowMemberProjectCreation", "allowSuperuserAccess", "avatar", "dateCreated", "hasAuthProvider", "id", "isEarlyAdopter", "links", "name", "require2FA", "slug", "status" ] }, "projects": { "type": "array", "items": { "type": "object", "properties": { "stats": {}, "transactionStats": {}, "sessionStats": {}, "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "isBookmarked": { "type": "boolean" }, "isMember": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "firstEvent": { "type": "string", "format": "date-time", "nullable": true }, "firstTransactionEvent": { "type": "boolean" }, "access": { "type": "array", "items": { "type": "string" } }, "hasAccess": { "type": "boolean" }, "hasFeedbacks": { "type": "boolean" }, "hasFlags": { "type": "boolean" }, "hasMinifiedStackTrace": { "type": "boolean" }, "hasMonitors": { "type": "boolean" }, "hasNewFeedbacks": { "type": "boolean" }, "hasProfiles": { "type": "boolean" }, "hasReplays": { "type": "boolean" }, "hasSessions": { "type": "boolean" }, "hasInsightsHttp": { "type": "boolean" }, "hasInsightsDb": { "type": "boolean" }, "hasInsightsAssets": { "type": "boolean" }, "hasInsightsAppStart": { "type": "boolean" }, "hasInsightsScreenLoad": { "type": "boolean" }, "hasInsightsVitals": { "type": "boolean" }, "hasInsightsCaches": { "type": "boolean" }, "hasInsightsQueues": { "type": "boolean" }, "hasInsightsAgentMonitoring": { "type": "boolean" }, "hasInsightsMCP": { "type": "boolean" }, "hasLogs": { "type": "boolean" }, "hasTraceMetrics": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "avatar": { "type": "object", "properties": { "avatarType": { "type": "string" }, "avatarUuid": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } } }, "color": { "type": "string" }, "status": { "type": "string" } }, "required": [ "access", "avatar", "color", "dateCreated", "features", "firstEvent", "firstTransactionEvent", "hasAccess", "hasFeedbacks", "hasFlags", "hasInsightsAgentMonitoring", "hasInsightsAppStart", "hasInsightsAssets", "hasInsightsCaches", "hasInsightsDb", "hasInsightsHttp", "hasInsightsMCP", "hasInsightsQueues", "hasInsightsScreenLoad", "hasInsightsVitals", "hasLogs", "hasMinifiedStackTrace", "hasMonitors", "hasNewFeedbacks", "hasProfiles", "hasReplays", "hasSessions", "hasTraceMetrics", "id", "isBookmarked", "isInternal", "isMember", "isPublic", "name", "platform", "slug", "status" ] } } }, "required": [ "access", "avatar", "dateCreated", "flags", "hasAccess", "id", "isMember", "isPending", "memberCount", "name", "slug", "teamRole" ] }, "TeamDetails": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "slug": { "type": "string", "description": "Uniquely identifies a team. This is must be available.", "maxLength": 50, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" } }, "required": [ "slug" ] }, "TeamPost": { "type": "object", "properties": { "slug": { "type": "string", "nullable": true, "description": "Uniquely identifies a team and is used for the interface. If not\n provided, it is automatically generated from the name.", "maxLength": 50, "pattern": "^(?![0-9]+$)[a-z0-9_\\-]+$" }, "name": { "type": "string", "nullable": true, "description": "**`[DEPRECATED]`** The name for the team. If not provided, it is\n automatically generated from the slug", "maxLength": 64, "deprecated": true } } }, "TeamSCIM": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "displayName": { "type": "string" }, "meta": { "type": "object", "properties": { "resourceType": { "type": "string" } }, "required": [ "resourceType" ] }, "members": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "display": { "type": "string" } }, "required": [ "display", "value" ] } } }, "required": [ "displayName", "id", "meta", "schemas" ] }, "TestResult": { "type": "object", "description": "Serializer for test results response including pagination metadata", "properties": { "defaultBranch": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "description": "Serializer for individual test result nodes from GraphQL response", "properties": { "updatedAt": { "type": "string" }, "avgDuration": { "type": "number", "format": "double" }, "totalDuration": { "type": "number", "format": "double" }, "name": { "type": "string" }, "failureRate": { "type": "number", "format": "double" }, "flakeRate": { "type": "number", "format": "double" }, "totalFailCount": { "type": "integer" }, "totalFlakyFailCount": { "type": "integer" }, "totalSkipCount": { "type": "integer" }, "totalPassCount": { "type": "integer" }, "lastDuration": { "type": "number", "format": "double" } }, "required": [ "avgDuration", "failureRate", "flakeRate", "lastDuration", "name", "totalDuration", "totalFailCount", "totalFlakyFailCount", "totalPassCount", "totalSkipCount", "updatedAt" ] } }, "pageInfo": { "type": "object", "description": "Serializer for pagination information", "properties": { "endCursor": { "type": "string", "nullable": true }, "startCursor": { "type": "string", "nullable": true }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" } }, "required": [ "endCursor", "hasNextPage", "hasPreviousPage", "startCursor" ] }, "totalCount": { "type": "integer" } }, "required": [ "defaultBranch", "pageInfo", "results", "totalCount" ] }, "TestResultAggregates": { "type": "object", "description": "Serializer for test results aggregates response", "properties": { "totalDuration": { "type": "number", "format": "double" }, "totalDurationPercentChange": { "type": "number", "format": "double" }, "slowestTestsDuration": { "type": "number", "format": "double" }, "slowestTestsDurationPercentChange": { "type": "number", "format": "double" }, "totalSlowTests": { "type": "integer" }, "totalSlowTestsPercentChange": { "type": "number", "format": "double" }, "totalFails": { "type": "integer" }, "totalFailsPercentChange": { "type": "number", "format": "double" }, "totalSkips": { "type": "integer" }, "totalSkipsPercentChange": { "type": "number", "format": "double" }, "flakeCount": { "type": "integer" }, "flakeCountPercentChange": { "type": "number", "format": "double" }, "flakeRate": { "type": "number", "format": "double" }, "flakeRatePercentChange": { "type": "number", "format": "double" } }, "required": [ "flakeCount", "flakeCountPercentChange", "flakeRate", "flakeRatePercentChange", "slowestTestsDuration", "slowestTestsDurationPercentChange", "totalDuration", "totalDurationPercentChange", "totalFails", "totalFailsPercentChange", "totalSkips", "totalSkipsPercentChange", "totalSlowTests", "totalSlowTestsPercentChange" ] }, "TestResultNode": { "type": "object", "description": "Serializer for individual test result nodes from GraphQL response", "properties": { "updatedAt": { "type": "string" }, "avgDuration": { "type": "number", "format": "double" }, "totalDuration": { "type": "number", "format": "double" }, "name": { "type": "string" }, "failureRate": { "type": "number", "format": "double" }, "flakeRate": { "type": "number", "format": "double" }, "totalFailCount": { "type": "integer" }, "totalFlakyFailCount": { "type": "integer" }, "totalSkipCount": { "type": "integer" }, "totalPassCount": { "type": "integer" }, "lastDuration": { "type": "number", "format": "double" } }, "required": [ "avgDuration", "failureRate", "flakeRate", "lastDuration", "name", "totalDuration", "totalFailCount", "totalFlakyFailCount", "totalPassCount", "totalSkipCount", "updatedAt" ] }, "TestSuite": { "type": "object", "description": "Serializer for test suites belonging to a repository's test results", "properties": { "testSuites": { "type": "array", "items": { "type": "string" } } }, "required": [ "testSuites" ] }, "UpdateClientKey": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for the client key" }, "isActive": { "type": "boolean", "description": "Activate or deactivate the client key." }, "rateLimit": { "type": "object", "description": "Applies a rate limit to cap the number of errors accepted during a given time window. To\ndisable entirely set `rateLimit` to null.\n```json\n{\n \"rateLimit\": {\n \"window\": 7200, // time in seconds\n \"count\": 1000 // error cap\n }\n}\n```", "properties": { "count": { "type": "integer", "minimum": 0, "nullable": true }, "window": { "type": "integer", "maximum": 86400, "minimum": 0, "nullable": true } } }, "browserSdkVersion": { "enum": [ "latest", "7.x" ], "type": "string", "description": "The Sentry Javascript SDK version to use. The currently supported options are:\n\n* `latest` - Most recent version\n* `7.x` - Version 7 releases" }, "dynamicSdkLoaderOptions": { "type": "object", "description": "Configures multiple options for the Javascript Loader Script.\n- `Performance Monitoring`\n- `Debug Bundles & Logging`\n- `Session Replay` - Note that the loader will load the ES6 bundle instead of the ES5 bundle.\n- `User Feedback` - Note that the loader will load the ES6 bundle instead of the ES5 bundle.\n- `Logs and Metrics` - Note that the loader will load the ES6 bundle instead of the ES5 bundle. Requires SDK >= 10.0.0.\n```json\n{\n \"dynamicSdkLoaderOptions\": {\n \"hasReplay\": true,\n \"hasPerformance\": true,\n \"hasDebug\": true,\n \"hasFeedback\": true,\n \"hasLogsAndMetrics\": true\n }\n}\n```", "properties": { "hasReplay": { "type": "boolean" }, "hasPerformance": { "type": "boolean" }, "hasDebug": { "type": "boolean" }, "hasFeedback": { "type": "boolean" }, "hasLogsAndMetrics": { "type": "boolean" } } } } }, "UpdateOrgMemberRoles": { "type": "object", "properties": { "orgRole": { "enum": [ "billing", "member", "manager", "owner", "admin" ], "type": "string", "description": "The organization role of the member. The options are:\n\n* `billing` - Can manage payment and compliance details.\n* `member` - Can view and act on events, as well as view most other data within the organization.\n* `manager` - Has full management access to all teams and projects. Can also manage\n the organization's membership.\n* `owner` - Has unrestricted access to the organization, its data, and its\n settings. Can add, modify, and delete projects and members, as well as\n make billing and plan changes.\n* `admin` - Can edit global integrations, manage projects, and add/remove teams.\n They automatically assume the Team Admin role for teams they join.\n Note: This role can no longer be assigned in Business and Enterprise plans. Use `TeamRoles` instead.\n " }, "teamRoles": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "nullable": true, "description": "\nConfigures the team role of the member. The two roles are:\n- `contributor` - Can view and act on issues. Depending on organization settings, they can also add team members.\n- `admin` - Has full management access to their team's membership and projects.\n```json\n{\n \"teamRoles\": [\n {\n \"teamSlug\": \"ancient-gabelers\",\n \"role\": \"admin\"\n },\n {\n \"teamSlug\": \"powerful-abolitionist\",\n \"role\": \"contributor\"\n }\n ]\n}\n```\n" } } }, "WidgetLayout": { "type": "object", "description": "Widget grid layout position and dimensions.\n\nThe dashboard uses a 6-column grid. Required keys: x, y, w, h, minH.\nConstraints: x (0-5), y (>= 0), w (1-6), h (>= 1), minH (>= 1), and x + w <= 6.", "properties": { "x": { "type": "integer", "maximum": 5, "minimum": 0, "description": "Column position (0-indexed)." }, "y": { "type": "integer", "minimum": 0, "description": "Row position (0-indexed)." }, "w": { "type": "integer", "maximum": 6, "minimum": 1, "description": "Width in grid columns (1-6)." }, "h": { "type": "integer", "minimum": 1, "description": "Height in grid rows." }, "min_h": { "type": "integer", "minimum": 1, "description": "Minimum height in grid rows." } }, "required": [ "h", "min_h", "w", "x", "y" ] }, "Workflow": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "triggers": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } }, "nullable": true }, "actionFilters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "logicType": { "type": "string" }, "conditions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "comparison": { "anyOf": [ { "type": "boolean" }, { "type": "integer" } ] }, "conditionResult": { "type": "boolean" } }, "required": [ "comparison", "conditionResult", "id", "type" ] } }, { "type": "array", "items": {} } ] }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "integrationId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string" } }, "config": { "type": "object", "additionalProperties": {} }, "status": { "type": "string" } } } }, { "type": "array", "items": {} } ] } } }, "nullable": true }, "environment": { "type": "string", "nullable": true }, "config": { "type": "object", "additionalProperties": {} }, "detectorIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" }, "lastTriggered": { "type": "string", "format": "date-time", "nullable": true }, "owner": { "type": "string", "nullable": true } }, "required": [ "actionFilters", "config", "createdBy", "dateCreated", "dateUpdated", "detectorIds", "enabled", "environment", "id", "lastTriggered", "name", "organizationId", "owner", "triggers" ] }, "WorkflowValidator": { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "name": { "type": "string", "description": "The name of the alert", "maxLength": 256 }, "id": { "type": "string", "description": "The ID of the existing alert" }, "enabled": { "type": "boolean", "default": true, "description": "Whether the alert is enabled or disabled" }, "detector_ids": { "type": "array", "items": { "type": "integer" }, "description": "The IDs of the monitors to connect this alert to. Use 'Fetch an Organization's Monitors' to find the IDs." }, "config": { "type": "object", "additionalProperties": {}, "description": "\n Typically the frequency at which the alert will fire, in minutes.\n\n - `0`: 0 minutes\n - `5`: 5 minutes\n - `10`: 10 minutes\n - `30`: 30 minutes\n - `60`: 1 hour\n - `180`: 3 hours\n - `720`: 12 hours\n - `1440`: 24 hours\n\n ```json\n {\n \"frequency\":3600\n }\n ```\n " }, "environment": { "type": "string", "nullable": true, "description": "The name of the environment for the alert to evaluate in" }, "triggers": { "allOf": [ { "type": "object", "description": "Allows parameters to be defined in snake case, but passed as camel case.\n\nErrors are output in camel case.", "properties": { "id": { "type": "string" }, "logic_type": { "enum": [ "any", "any-short", "all", "none" ], "type": "string", "description": "* `any`\n* `any-short`\n* `all`\n* `none`" }, "conditions": { "type": "array", "items": {} } }, "required": [ "logic_type" ] } ], "description": "The conditions on which the alert will trigger. See available options below.\n ```json\n \"triggers\": {\n \"organizationId\": \"1\",\n \"logicType\": \"any-short\",\n \"conditions\": [\n {\n \"type\": \"first_seen_event\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"issue_resolved_trigger\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"reappeared_event\",\n \"comparison\": true,\n \"conditionResult\": true\n },\n {\n \"type\": \"regression_event\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ],\n \"actions\": []\n }\n ```\n " }, "action_filters": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "The filters to run before the action will fire and the action(s) to fire.\n\n `logicType` can be one of `any-short`, `all`, or `none`.\n\n Below is a basic example. See below for all other options.\n\n ```json\n \"actionFilters\": [\n {\n \"logicType\": \"any\",\n \"conditions\": [\n {\n \"type\": \"level\",\n \"comparison\": {\n \"level\": 50,\n \"match\": \"eq\"\n },\n \"conditionResult\": true\n }\n ],\n \"actions\": [\n {\n \"id\": \"123\",\n \"type\": \"email\",\n \"integrationId\": null,\n \"data\": {},\n \"config\": {\n \"targetType\": \"user\",\n \"targetDisplay\": null,\n \"targetIdentifier\": \"56789\"\n },\n \"status\": \"active\"\n }\n ]\n }\n ]\n ```\n\n ## Conditions\n\n **Issue Age**\n - `time`: One of `minute`, `hour`, `day`, or `week`.\n - `value`: A positive integer.\n - `comparisonType`: One of `older` or `newer`.\n ```json\n {\n \"type\": \"age_comparison\",\n \"comparison\": {\n \"time\": \"minute\",\n \"value\": 10,\n \"comparisonType\": \"older\"\n },\n \"conditionResult\": true\n }\n\n ```\n\n **Issue Assignment**\n - `targetType`: Who the issue is assigned to\n - `Unassigned`: Unassigned\n - `Member`: Assigned to a user\n - `Team`: Assigned to a team\n - `targetIdentifier`: The ID of the user or team from the `targetType`. Enter \"\" if `targetType` is `Unassigned`.\n ```json\n {\n \"type\": \"assigned_to\",\n \"comparison\": {\n \"targetType\": \"Member\",\n \"targetIdentifier\": 123456\n },\n \"conditionResult\": true\n }\n ```\n\n **Issue Category**\n - `value`: The issue category to filter to.\n - `1`: Error issues\n - `6`: Feedback issues\n - `10`: Outage issues\n - `11`: Metric issues\n - `12`: DB Query issues\n - `13`: HTTP Client issues\n - `14`: Front end issues\n - `15`: Mobile issues\n ```json\n {\n \"type\": \"issue_category\",\n \"comparison\": {\n \"value\": 1\n },\n \"conditionResult\": true\n }\n ```\n\n **Issue Frequency**\n - `value`: A positive integer representing how many times the issue has to happen before the alert will fire.\n ```json\n {\n \"type\": \"issue_occurrences\",\n \"comparison\": {\n \"value\": 10\n },\n \"conditionResult\": true\n }\n ```\n\n **De-escalation**\n ```json\n {\n \"type\": \"issue_priority_deescalating\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ```\n\n **Issue Priority**\n - `comparison`: The priority the issue must be for the alert to fire.\n - `75`: High priority\n - `50`: Medium priority\n - `25`: Low priority\n ```json\n {\n \"type\": \"issue_priority_greater_or_equal\",\n \"comparison\": 75,\n \"conditionResult\": true\n }\n ```\n\n **Number of Users Affected**\n - `value`: A positive integer representing the number of users that must be affected before the alert will fire.\n - `filters`: A list of additional sub-filters to evaluate before the alert will fire.\n - `interval`: The time period in which to evaluate the value. e.g. Number of users affected by an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"event_unique_user_frequency_count\",\n \"comparison\": {\n \"value\": 100,\n \"filters\": [{\"key\": \"foo\", \"match\": \"eq\", \"value\": \"bar\"}],\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Number of Events**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"event_frequency_count\",\n \"comparison\": {\n \"value\": 100,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Percent of Events**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is `comparisonInterval` percent higher `value` compared to `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n - `comparisonInterval`: The time period to compare against. See `interval` for options.\n ```json\n {\n \"type\": \"event_frequency_percent\",\n \"comparison\": {\n \"value\": 100,\n \"interval\": \"1h\",\n \"comparisonInterval\": \"1w\"\n },\n \"conditionResult\": true\n }\n\n ```\n\n **Percentage of Sessions Affected Count**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is more than `value` in `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n ```json\n {\n \"type\": \"percent_sessions_count\",\n \"comparison\": {\n \"value\": 10,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Percentage of Sessions Affected Percent**\n - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire\n - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is `comparisonInterval` percent higher `value` compared to `interval`.\n - `1min`: 1 minute\n - `5min`: 5 minutes\n - `15min`: 15 minutes\n - `1hr`: 1 hour\n - `1d`: 1 day\n - `1w`: 1 week\n - `30d`: 30 days\n - `comparisonInterval`: The time period to compare against. See `interval` for options.\n ```json\n {\n \"type\": \"percent_sessions_percent\",\n \"comparison\": {\n \"value\": 10,\n \"interval\": \"1h\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Event Attribute**\n The event's `attribute` value `match` `value`\n\n - `attribute`: The event attribute to match on. Valid values are: `message`, `platform`, `environment`, `type`, `error.handled`, `error.unhandled`, `error.main_thread`, `exception.type`, `exception.value`, `user.id`, `user.email`, `user.username`, `user.ip_address`, `http.method`, `http.url`, `http.status_code`, `sdk.name`, `stacktrace.code`, `stacktrace.module`, `stacktrace.filename`, `stacktrace.abs_path`, `stacktrace.package`, `unreal.crash_type`, `app.in_foreground`.\n - `match`: The comparison operator\n - `co`: Contains\n - `nc`: Does not contain\n - `eq`: Equals\n - `ne`: Does not equal\n - `sw`: Starts with\n - `ew`: Ends with\n - `is`: Is set\n - `ns`: Is not set\n - `value`: A string. Not required when match is `is` or `ns`.\n\n ```json\n {\n \"type\": \"event_attribute\",\n \"comparison\": {\n \"match\": \"co\",\n \"value\": \"bar\",\n \"attribute\": \"message\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Tagged Event**\n The event's tags `key` match `value`\n - `key`: The tag value\n - `match`: The comparison operator\n - `co`: Contains\n - `nc`: Does not contain\n - `eq`: Equals\n - `ne`: Does not equal\n - `sw`: Starts with\n - `ew`: Ends with\n - `is`: Is set\n - `ns`: Is not set\n - `value`: A string. Not required when match is `is` or `ns`.\n\n ```json\n {\n \"type\": \"tagged_event\",\n \"comparison\": {\n \"key\": \"level\",\n \"match\": \"eq\",\n \"value\": \"error\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Latest Release**\n The event is from the latest release\n\n ```json\n {\n \"type\": \"latest_release\",\n \"comparison\": true,\n \"conditionResult\": true\n }\n ```\n\n **Release Age**\n ```json\n {\n \"type\": \"latest_adopted_release\",\n \"comparison\": {\n \"environment\": \"12345\",\n \"ageComparison\": \"older\",\n \"releaseAgeType\": \"oldest\"\n },\n \"conditionResult\": true\n }\n ```\n\n **Event Level**\n The event's level is `match` `level`\n - `match`: The comparison operator\n - `eq`: Equal\n - `gte`: Greater than or equal\n - `lte`: Less than or equal\n - `level`: The event level\n - `50`: Fatal\n - `40`: Error\n - `30`: Warning\n - `20`: Info\n - `10`: Debug\n - `0`: Sample\n\n ```json\n {\n \"type\": \"level\",\n \"comparison\": {\n \"level\": 50,\n \"match\": \"eq\"\n },\n \"conditionResult\": true\n }\n ```\n\n ## Actions\n A list of actions that take place when all required conditions and filters for the alert are met. See below for a list of possible actions.\n\n\n **Notify on Preferred Channel**\n - `data`: A dictionary with the fallthrough type option when choosing to notify Suggested Assignees. Leave empty if notifying a user or team.\n - `fallthroughType`\n - `ActiveMembers`\n - `AllMembers`\n - `NoOne`\n - `config`: A dictionary with the configuration options for notification.\n - `targetType`: The type of recipient to notify\n - `user`: User\n - `team`: Team\n - `issue_owners`: Suggested Assignees\n - `targetDisplay`: null\n - `targetIdentifier`: The id of the user or team to notify. Leave null for Suggested Assignees.\n\n ```json\n {\n \"type\":\"email\",\n \"integrationId\":null,\n \"data\":{},\n \"config\":{\n \"targetType\":\"user\",\n \"targetDisplay\":null,\n \"targetIdentifier\":\"232692\"\n },\n \"status\":\"active\"\n },\n {\n \"type\":\"email\",\n \"integrationId\":null,\n \"data\":{\n \"fallthroughType\":\"ActiveMembers\"\n },\n \"config\":{\n \"targetType\":\"issue_owners\",\n \"targetDisplay\":null,\n \"targetIdentifier\":\"\"}\n ,\n \"status\":\"active\"\n }\n ```\n **Notify on Slack**\n - `targetDisplay`: The name of the channel to notify in.\n `integrationId`: The stringified ID of the integration.\n\n ```json\n {\n \"type\":\"slack\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"\",\n \"targetDisplay\":\"notify-errors\"\n },\n \"integrationId\":\"1\",\n \"data\":{},\n \"status\":\"active\"\n }\n ```\n\n **Notify on PagerDuty**\n - `targetDisplay`: The name of the service to create the ticket in.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"priority\"]`: The severity level for the notification.\n\n ```json\n {\n \"type\":\"pagerduty\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"123456\",\n \"targetDisplay\":\"Error Service\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"priority\":\"default\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on Discord**\n - `targetDisplay`: The name of the service to create the ticket in.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"tags\"]`: Comma separated list of tags to add to the notification.\n\n ```json\n {\n \"type\":\"discord\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"12345\",\n \"targetDisplay\":\"\",\n },\n \"integrationId\":\"1234\",\n \"data\":{\n \"tags\":\"transaction,environment\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on MSTeams**\n - `targetIdentifier` - The integration ID associated with the Microsoft Teams team.\n - `targetDisplay` - The name of the channel to send the notification to.\n - `integrationId`: The stringified ID of the integration.\n ```json\n {\n \"type\":\"msteams\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"19:a4b3kghaghgkjah357y6847@thread.skype\",\n \"targetDisplay\":\"notify-errors\"\n },\n \"integrationId\":\"1\",\n \"data\":{},\n \"status\":\"active\"\n }\n ```\n\n **Notify on OpsGenie**\n - `targetDisplay`: The name of the Opsgenie team.\n - `targetIdentifier`: The ID of the Opsgenie team to send the notification to.\n - `integrationId`: The stringified ID of the integration.\n - `data[\"priority\"]`: The priority level for the notification.\n\n ```json\n {\n \"type\":\"opsgenie\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\"123456-Error-Service\",\n \"targetDisplay\":\"Error Service\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"priority\":\"P3\"\n },\n \"status\":\"active\"\n }\n ```\n\n **Notify on Azure DevOps**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"vsts\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a Jira ticket**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"jira\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a Jira Server ticket**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"jira_server\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{...},\n \"status\":\"active\"\n }\n ```\n\n **Create a GitHub issue**\n - `integrationId`: The stringified ID of the integration.\n - `data` - A list of any fields you want to include in the ticket as objects.\n\n ```json\n {\n \"type\":\"github\",\n \"config\":{\n \"targetType\":\"specific\",\n \"targetIdentifier\":\",\n \"targetDisplay\":\"\"\n },\n \"integrationId\":\"2345\",\n \"data\":{\n \"additional_fields\": {\n \"assignee\": \"\",\n \"integration\": \"2345\",\n \"labels\": [],\n \"repo\": \"example-repo\",\n },\n \"dynamic_form_fields\": [\n {\n \"choices\": [[\"YourOrg/example-repo\", \"example-repo\"]],\n \"default\": \"YourOrg/example-repo\",\n \"label\": \"GitHub Repository\",\n \"name\": \"repo\",\n \"required\": true\n \"type\": \"select\",\n \"updatesForm\": true,\n \"url\": \"/extensions/github/search/example-repo/1234567/\",\n },\n ],\n },\n \"status\":\"active\"\n }\n ```\n " }, "owner": { "type": "string", "nullable": true, "description": "\n The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'.\n\n **User**\n ```json\n \"user:123456\"\n ```\n\n **Team**\n ```json\n \"team:456789\"\n ```\n " } }, "required": [ "name" ] }, "_LegacyBrowserFilter": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Toggle the browser-extensions, localhost, filtered-transaction, or web-crawlers filter on or off." }, "subfilters": { "type": "array", "items": { "enum": [ "ie", "edge", "safari", "firefox", "chrome", "opera", "android", "opera_mini", "ie_pre_9", "ie9", "ie10", "ie11", "opera_pre_15", "android_pre_4", "safari_pre_6", "opera_mini_pre_8", "edge_pre_79" ], "type": "string", "description": "* `ie`\n* `edge`\n* `safari`\n* `firefox`\n* `chrome`\n* `opera`\n* `android`\n* `opera_mini`\n* `ie_pre_9`\n* `ie9`\n* `ie10`\n* `ie11`\n* `opera_pre_15`\n* `android_pre_4`\n* `safari_pre_6`\n* `opera_mini_pre_8`\n* `edge_pre_79`" }, "description": "\nSpecifies which legacy browser filters should be active. Anything excluded from the list will be\ndisabled. The options are:\n- `ie` - Internet Explorer Version 11 and lower\n- `edge` - Edge Version 110 and lower\n- `safari` - Safari Version 15 and lower\n- `firefox` - Firefox Version 110 and lower\n- `chrome` - Chrome Version 110 and lower\n- `opera` - Opera Version 99 and lower\n- `android` - Android Version 3 and lower\n- `opera_mini` - Opera Mini Version 34 and lower\n\nDeprecated options:\n- `ie_pre_9` - Internet Explorer Version 8 and lower\n- `ie9` - Internet Explorer Version 9\n- `ie10` - Internet Explorer Version 10\n- `ie11` - Internet Explorer Version 11\n- `safari_pre_6` - Safari Version 5 and lower\n- `opera_pre_15` - Opera Version 14 and lower\n- `opera_mini_pre_8` - Opera Mini Version 8 and lower\n- `android_pre_4` - Android Version 3 and lower\n- `edge_pre_79` - Edge Version 18 and lower (non Chromium based)\n" } } } }, "securitySchemes": { "auth_token": { "type": "http", "scheme": "bearer" }, "dsn": { "type": "http", "scheme": "DSN" } } }, "servers": [ { "url": "https://{region}.sentry.io", "variables": { "region": { "default": "us", "description": "The data-storage-location for an organization", "enum": [ "us", "de" ] } } } ], "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" } }, { "name": "Discover", "x-sidebar-name": "Discover & Performance", "description": "Discover and Performance allow you to slice and dice your Error and Transaction events", "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" } }, { "name": "Explore", "x-sidebar-name": "Explore", "description": "Explore allow you to slice and dice your events", "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" } }, { "name": "Dashboards", "x-sidebar-name": "Dashboards", "description": "Endpoints for Dashboards", "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": "Crons", "x-sidebar-name": "Crons", "description": "Endpoints for Crons", "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": "Replays", "x-sidebar-name": "Replays", "description": "Endpoints for Replays", "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": "Spike Protection", "x-sidebar-name": "Spike Protection Notifications", "description": "Endpoints for Spike Protection Notifications", "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": "Monitors", "x-sidebar-name": "Monitors & Alerts", "description": "Endpoints for Monitors and Alerts", "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/monitors/&template=api_error_template.md" } }, { "name": "Integrations", "x-sidebar-name": "Integrations", "description": "Endpoints for Integrations", "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": "Environments", "x-sidebar-name": "Environments", "description": "Endpoints for Environments", "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": "Users", "x-sidebar-name": "Users", "description": "Endpoints for Users", "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": "Prevent", "x-sidebar-name": "Prevent", "description": "Endpoints for Prevent", "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/prevent/&template=api_error_template.md" } }, { "name": "Seer", "description": "Endpoints for Seer features", "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/seer/&template=api_error_template.md" } }, { "name": "Mobile Builds", "description": "Endpoints for mobile build analysis", "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/preprodartifacts/size-analysis/&template=api_error_template.md" } } ] }