Springloops API Documentation

Servers

List project servers

Returns servers in the project.

Resource URL
GET
/project/:projectId/servers
Example
Request
GET
https://pickles.springloops.io/api/project/1/servers
URL Parameters
Name Description
projectId integer The numerical ID of the desired project.
Sample Response
{
  "success": true,
  "data": [
   {
      "id": 4,
      "name": "dev",
      "role": "DEVELOPMENT",
      "revision": null,
      "headRevision": "ec21a1bb15138bbd33587c95feb750348065aef5",
      "projectPathInRepository": "/",
      "autoDeploy": false,
      "deployStatus": null,
      "type": "FTP"
    }
  ]
}

Delete server

Deletes a server.

Resource URL
DELETE
/project/:projectId/server/:serverId
Example
Request
DELETE
https://pickles.springloops.io/api/project/1/server/2
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
}

Add new server

Creates a new server in the project.

Resource URL
POST
/project/:projectId/servers
URL Parameters
Name Description
projectId Required Integer The numerical ID of the desired project.
POST Parameters
Name Description
name Required String The name of the release scenario.
role Required String Specifies the role of new server. DEVELOPMENT, PRODUCTION or STAGING
projectPathInRepository Required string The path in the repository.
protocol Required String Communication protocol. Possible values: SFTP_PASS, WEB_DAV, AMAZON_S3, SFTP_KEY_PASS, SFTP_KEY, FTPS_PASSIVE, FTPS_ACTIVE, FTP_PASSIVE, FTP_ACTIVE
branch String Required if the projects repository type is GIT.
revision String Default revision on the server.
isAutoDeployment Boolean Specifies if the server deploy is run automatically on every push to the branch.
bucket_name String The name of the Amazon S3 Bucket. Restricted to and required for AMAZON_S3.
access_key String The Access Key for Amazon S3. Restricted to and required for AMAZON_S3.
secret_key String The Secret Key for Amazon S3. Restricted to and required for AMAZON_S3.
public Boolean Makes files accessible through public HTTP. Restricted to AMAZON_S3.
cloudFrontId String The ID of the Amazon Cloud Front. Restricted to AMAZON_S3.
reducedRedundancy Boolean The user's reduced redundancy. Restricted to AMAZON_S3.
login String The username required to connect the server. Restricted to and required if the type is FTPS_PASSIVE, FTPS_ACTIVE, FTP_PASSIVE or FTP_ACTIVE.
password String The password required to connect the server. Restricted to and required if the type is FTPS_PASSIVE, FTPS_ACTIVE, FTP_PASSIVE or FTP_ACTIVE.
host String The host for the connection. Restricted to and required if the type is SFTP_PASS, SFTP_KEY_PASS, SFTP_KEY, FTPS_PASSIVE, FTPS_ACTIVE, FTP_PASSIVE or FTP_ACTIVE.
port Integer The port for the connection. Restricted to and required if the type is SFTP_PASS, SFTP_KEY_PASS, SFTP_KEY, FTPS_PASSIVE, FTPS_ACTIVE, FTP_PASSIVE or FTP_ACTIVE.
path String Path on the server or on Amazon bucket. Restricted to and required if the type is AMAZON_S3, SFTP_PASS, SFTP_KEY_PASS, SFTP_KEY, FTPS_PASSIVE, FTPS_ACTIVE, FTP_PASSIVE or FTP_ACTIVE.
isPathAbsolute Boolean Specifies if given path is absolute or relative.
privateKey String The private SSH key. Restricted to and required if the type is SFTP_KEY_PASS or SFTP_KEY.
passphrase String The passphrase for the private SSH key. Restricted to SFTP. Restricted to and required if the type is SFTP_KEY_PASS or SFTP_KEY.
Example
Request
POST
https://pickles.springloops.io/api/project/5/servers
{
"name": "NewServer",
"role": "DEVELOPMENT",
"projectPathInRepository": "/",
"protocol": "FTP_PASSIVE",
"host": "192.168.1.2",
"port": 21,
"path": "/var",
"username": "username",
"password": "password",
"isPathAbsolute": false
}
Sample Response
{
  "success": true,
  "data": {
    "id": 16,
    "name": "NewServer",
    "role": "DEVELOPMENT",
    "revision": null,
    "headRevision": "236afa836c2b5902077859c558efbd11351dcaac",
    "projectPathInRepository": "/",
    "autoDeploy": false,
    "deployStatus": null,
    "type": "FTP"
  }
}
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.