Create a New Release for an Organization

Create a new release for the given organization. Releases are used by Sentry to improve its error reporting abilities by correlating first seen events with the release that might have introduced the problem. Releases are also necessary for source maps and other debug features that require manual upload for functioning well.

Options

Organization Id or Slug

The id or slug of the organization.

Body

Request body which must comply to the following JSON Schema:

{
  "required" : [ "projects", "version" ],
  "type" : "object",
  "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",
      "description" : "An optional date that indicates when the release went live. If not provided the current time is assumed.",
      "format" : "date-time"
    },
    "commits" : {
      "type" : "array",
      "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`.",
      "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" : {
              "required" : [ "path", "type" ],
              "type" : "object",
              "properties" : {
                "path" : {
                  "type" : "string",
                  "description" : "The path to the file. Both forward and backward slashes are supported."
                },
                "type" : {
                  "type" : "string",
                  "description" : "The type of change that happened in the commit.",
                  "enum" : [ "A", "M", "D" ]
                }
              }
            }
          },
          "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-<organization_id>' (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",
            "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.",
            "format" : "date-time"
          },
          "message" : {
            "type" : "string",
            "description" : "The commit message."
          },
          "id" : {
            "type" : "string",
            "description" : "The commit ID (the commit SHA)."
          }
        }
      }
    },
    "refs" : {
      "type" : "array",
      "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`.",
      "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."
          }
        }
      }
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Id:
• Authors:
• Commit Count:
• Data:
• Date Created:
• Date Released:
• Deploy Count:
• First Event:
• Last Commit:
• Last Deploy:
• Last Event:
• New Groups:
• Owner:
• Projects:
• Ref:
• Short Version:
• Version:
• Url:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers