• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / / REST API

index-snapshot

Postman Collection
OpenAPI
Operations
GET/api/2/index-snapshotPOST/api/2/index-snapshotGET/api/2/index-snapshot/isRunning
GET

Get list of available index snapshots

Lists available index snapshots absolute paths with timestamps

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns the list consisting of absolute paths to currently available index snapshots

application/json

IndexSnapshotBean
GET/api/2/index-snapshot
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/index-snapshot' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Create index snapshot if not in progress

Starts taking an index snapshot if no other snapshot creation process is in progress

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns the absolute path which index snapshot will be placed in, after it's created

application/json

IndexSnapshotPromiseBean
POST/api/2/index-snapshot
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/index-snapshot' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get index snapshot creation status

Checks if index snapshot creation is currently running

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns status of current snapshot creation

application/json

IndexSnapshotStatusBean
GET/api/2/index-snapshot/isRunning
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/index-snapshot/isRunning' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

Rate this page: