Springloops API Documentation

Deploys

List project deploys

Returns deploys in the project.

Resource URL
GET
/project/:projectId/deploys
Example
Request
GET
https://pickles.springloops.io/api/project/1/deploys?limit=1
URL Parameters
Name Description
projectId integer The numerical ID of the desired project.
GET Parameters
Name Description
limit Integer Number of items to return. Default value is 30 and maximum value is 100.
Sample Response
{
  "success": true,
  "data": [
    {
      "type": "REFRESH",
      "status": "SUCCESSFUL",
      "toRevision": "236afa836c2b5902077859c558efbd11351dcaac",
      "fromRevision": null,
      "requestDate": "2016-01-25T09:41:58",
      "finishDate": "2016-01-25T09:42:01",
      "progressInPercentages": 100,
      "errorMessage": null,
      "requestedBy": {
        "id": 4,
        "avatarSmall": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/30/30/AVATAR.png",
        "avatarLarge": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/60/60/AVATAR.png",
        "avatarMicro": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/16/16/AVATAR.png",
        "shortName": "Owner L.",
        "firstName": "Owner",
        "lastName": "Lastname"
      },
      "isAutoDeployment": false,
      "id": 5,
      "serverId": 15
    }
  ]
}

Get deploy

Returns last deploy on a desired server.

Resource URL
GET
/project/:projectId/server/:serverId/deploy
Example
Request
GET
https://pickles.springloops.io/api/project/1/server/2/deploy
URL Parameters
Name Description
projectId integer The numerical ID of the desired project.
serverId integer The numerical ID of the desired server.
Sample Response
{
  "success": true,
  "data": [
    {
      "type": "REFRESH",
      "status": "SUCCESSFUL",
      "toRevision": "236afa836c2b5902077859c558efbd11351dcaac",
      "fromRevision": null,
      "requestDate": "2016-01-25T09:41:58",
      "finishDate": "2016-01-25T09:42:01",
      "progressInPercentages": 100,
      "errorMessage": null,
      "requestedBy": {
        "id": 4,
        "avatarSmall": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/30/30/AVATAR.png",
        "avatarLarge": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/60/60/AVATAR.png",
        "avatarMicro": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/16/16/AVATAR.png",
        "shortName": "Owner L.",
        "firstName": "Owner",
        "lastName": "Lastname"
      },
      "isAutoDeployment": false,
      "id": 5,
      "serverId": 15
    }
  ]
}

Run deployment

Runs a new deploy in desired server.

Resource URL
POST
/project/:projectId/server/:serverId/deploy
Example
Request
POST
https://pickles.springloops.io/api/project/1/server/2/deploy
URL Parameters
Name Description
projectId integer The numerical ID of the desired project.
serverId integer The numerical ID of the desired server.
POST parameters
Name Description
revision Required string The revision from the repository that will be released in the scenario.
refresh Required bool If true all files will be uploaded from scratch.
Sample Request
{
    "revision": "236afa836c2b5902077859c558efbd11351dcaac",
    "refresh": true
}
Sample Response
{
  "success": true,
  "data": {
    "type": "REFRESH",
    "status": "INPROGRESS",
    "toRevision": "236afa836c2b5902077859c558efbd11351dcaac",
    "fromRevision": "236afa836c2b5902077859c558efbd11351dcaac",
    "requestDate": "2016-01-25T12:08:00",
    "finishDate": null,
    "progressInPercentages": 0,
    "errorMessage": null,
    "requestedBy": {
      "id": 4,
      "avatarSmall": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/30/30/AVATAR.png",
      "avatarLarge": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/60/60/AVATAR.png",
      "avatarMicro": "https://pickles.springloops.io/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/16/16/AVATAR.png",
      "shortName": "Owner L.",
      "firstName": "Owner",
      "lastName": "Lastname"
    },
    "isAutoDeployment": false,
    "id": 6,
    "serverId": 2
  }
}
Create a free account
Leave a message

Have a question about Springloops or one of our apps? Leave a message here and we'll get back to you as soon as we can.