Skip to content
forgit api docs

Export issues

Deprecated
POST
/repositories/{workspace}/{repo_slug}/issues/export

A POST request to this endpoint initiates a new background celery task that archives the repo’s issues.

When the job has been accepted, it will return a 202 (Accepted) along with a unique url to this job in the ‘Location’ response header. This url is the endpoint for where the user can obtain their zip files.“

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
repo_slug
required
string

This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Request Body

Section titled “ Request Body ”

The options to apply to the export. Available options include project_key and project_name which, if specified, are used as the Jira space key and name in the exported Jira json format. Option send_email specifies whether an email should be sent upon export result. Option include_attachments specifies whether attachments are included in the export.

Media type application/json
Export Options

Options for issue export.

object
type
required
string
project_key
string
project_name
string
send_email
boolean
include_attachments
boolean
key
additional properties
any
Example generated 
{
  "type": "example",
  "project_key": "example",
  "project_name": "example",
  "send_email": true,
  "include_attachments": true
}

Responses

Section titled “ Responses ”

202

Section titled “ 202 ”

The export job has been accepted

401

Section titled “ 401 ”

The request wasn’t authenticated properly

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

403

Section titled “ 403 ”

When the authenticated user does not have admin permission on the repo

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

404

Section titled “ 404 ”

The repo does not exist or does not have an issue tracker

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}