<< Back to GForge REST API

Entity: Snapshot

GET

getDownload

Download the specified snapshot file. Only project admins are allowed to do this.

Parameters (1)

Name Type Description
id string Name of the file to be downloaded

Return: void

No return type is defined

getRequest

Determine if the specified project has an existing snapshot request.

Parameters (1)

Name Type Description
id int The project to check. Provided as part of the route.

Return: \StdClass

Object with succeeded (boolean), data (boolean for this method), and message (not used for this method).

getSnapshot

Gets a list of available snapshots. IF a project ID or unixName is provided, only snapshots for that project will be returned. Otherwise, the specified page of snapshots will be returned across all projects.

Parameters (1)

Name Type Description
int|string id (optional) ID or unixName of the project for which to list snapshots. This is taken from the route.
Pageable
Use the page_size and page_num parameters to control the set of records returned.

Return: Array

Assoc array of unixName => snapshot file name

POST

postRequest

Create a project snapshot request, iff it does not already exist

Parameters (1)

Name Type Description
id int The project for which the request should be checked and created.

Return: \StdClass

Object with succeeded (boolean), data (boolean for this method), and message (not used for this method).

PUT

DELETE

deleteRequest

Delete an existing project snapshot request, iff it exists

Parameters (1)

Name Type Description
id int The project for which the request should be checked and deleted.

Return: \StdClass

Object with succeeded (boolean), data (boolean for this method), and message (not used for this method).

deleteSnapshot

Delete an existing project snapshot request, iff it exists

Parameters (1)

Name Type Description
id int The project for which the request should be checked and deleted.

Return: \StdClass

Object with succeeded (boolean), data (boolean for this method), and message (not used for this method).