Mapping of URIs that begin with /kwatee/api
REST Commands Summary | |
---|---|
Login |
Authenticates a user |
Logout |
Logs current user out |
GetArtifacts |
Retrieves the list of artifacts in the repository |
GetArtifact |
Retrieves an artifact's properties |
UpdateArtifact |
Updates an artifact's properties |
CreateArtifact |
Creates a new artifact and optionally set additional properties |
DeleteArtifact |
Deletes an artifact |
GetVersion |
Retrieves the properties of an artifact's version |
UpdateVersion |
Updates an artifact's version properties |
CreateOrDuplicateVersion |
Creates or duplicates a version in an artifact and optionally set additional properties |
DeleteVersion |
Deletes an artifact's version |
UploadArtifactPackage |
Uploads a package to an artifact's version |
GetArtifactPackageFiles |
Retrieves the files present in a version's package at a given relative path |
GetArtifactSpecialFiles |
Retrieves all the special files within the package |
UpdateArtifactPackageFileProperties |
Updates custom flags of a file within a package |
DownloadArtifactPackageFile |
Downloads a file within the package in the specified location |
UploadArtifactPackageOverlay |
Uploads an overlay at a relative path within the package |
DeleteArtifactPackageOverlay |
Deletes an existing version overlay |
GetArtifactVariables |
Retrieves the list of version variables |
SetArtifactVariables |
Sets version variables |
ImportArtifactsBundle |
Uploads an artifacts bundle into the repository |
GetServers |
Retrieves the list of servers in the repository |
GetServer |
Retrieves server properties |
UpdateServers |
Updates the properties of a server |
CreateOrDuplicateServer |
Creates or duplicates a server and optionally set additional properties |
DeleteServer |
Deletes a server |
ServerDiagnostics |
Tests a connection to the server and returns server capabilities |
GetEnvironments |
Retrieves the list of environments in the repository |
GetEnvironment |
Retrieves an environment's properties |
UpdateEnvironment |
Updates the environment with new properties |
CreateOrDuplicateEnvironment |
Creates or duplicates an environment and optionally set additional properties |
DeleteEnvironment |
Deletes an environment |
GetRelease |
Retrieve an environment's release properties |
UpdateRelease |
Updates a release with new properties |
TagRelease |
Tags a release and optionally sets additional properties |
DeleteRelease |
Deletes a release |
ReeditRelease |
Reedits a previously tagged release |
GetEffectiveReleaseArtifacts |
Retrieves the effective release artifacts |
SetReleaseArtifactActiveVersion |
Sets the active version (default of server-specific) of a release artifact |
GetReleasePackageFiles |
Retrieves the files present in an release artifact package at a given relative path within the package |
GetReleaseSpecialFiles |
Retrieves all the special files within the release artifact package |
UpdateReleasePackageFileProperties |
Update custom flags of a file within a release artifact package |
DownloadReleasePackageFile |
Downloads a file within the release artifact package |
UploadReleasePackageOverlay |
Uploads an overlay at a relative path within the release artifact package |
DeleteReleasePackageOverlay |
Deletes an existing release artifact package overlay |
GetReleaseVariables |
Retrieves release variables |
SetReleaseVariables |
Sets the release variables |
GetDeployments |
Retrieves the list of deployments |
GetDeployment |
Retrieves the deployment properties |
DownloadLightweightInstaller |
Downloads a self-contained command-line installer (to install one server at a time) |
DownloadInstaller |
Downloads an installer |
ManageDeploy |
Initiates a deploy operation |
ManageUndeploy |
Initiates an undeploy operation |
ManageCheckIntegrity |
Initiates a check integrity operation |
ManageStart |
Initiates a start executables operation |
ManageStop |
Initiates a stop executables operation |
ManageStatus |
Initiates an executables status operation |
GetOngoingOperation |
Retrieves an ongoing deployment operation |
hasOperationCompleted |
Is an ongoing operation in progress? |
GetOperationProgress |
Retrieves the progress of a deployment operation |
GetProgressMessages |
Retrieves the details of a deployment operation for a given server and or artifact |
ManageCancel |
Cancels an ongoing operation |
SendCredentials |
Supply server credentials without storing them in kwatee |
GetInfoContext |
Retrieves kwatee information |
GetInfoPlatforms |
Retrieves the available platforms |
GetInfoConduitTypes |
Retrieves the available conduit types |
GetInfoServerPoolTypes |
Retrieves the available server pool types |
POST /kwatee/api/authenticate/{userName}
Authenticates a user. The password is expected in the X-API-AUTH
http headers.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | userName | the user to authenticate | String |
true |
Returns text/plain
encoded authentication token
200
success401
incorrect user or password410
missing or unreachable kwatee database500
internal errorSet HTTP header: X-API-AUTH=password
Request | POST http://kwatee.local:8080/kwate/api/authenticate/admin
|
Response | 200
WBqmpTYhcMM22hg5-HrFAxC-cTt3ec8BubiqR... |
POST /kwatee/api/logout
Logs current user out.
200
successRequest | POST http://kwatee.local:8080/kwate/api/logout
|
Response | 200
|
GET /kwatee/api/artifacts.json
Retrieves the list of artifacts in the repository.
Returns application/json
array of artifact objects
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/artifacts.json
|
Response | 200
[ { "description" : "Demo PHP web site", "name" : "demowebsite" } ] |
GET /kwatee/api/artifacts/{artifactName}.json
Retrieves an artifact's properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of an artifact | String |
true |
Returns application/json
artifact object
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/artifacts/demowebsite.json
|
Response | 200
{ "name" : "demowebsite", "description" : "Demo PHP web site", "versions" : [ { "name" : "1.0", "description" : "initial release", "platforms" : [ 1, 2, 7 ] } ] } |
PUT /kwatee/api/artifacts/{artifactName}
Updates an artifact's properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of an artifact | String |
true |
RequestBody | artifactProperties | the JSON artifact's properties to update | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/artifacts/demowebsite
{ "description" : "new description" } |
Response | 200
|
POST /kwatee/api/artifacts/{artifactName}
Creates a new artifact and optionally set additional properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the artifact to create | String |
true |
RequestBody | artifactProperties | the JSON artifact's properties to update or empty | String |
true |
201
created401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/artifacts/testArtifact
{ "description" : "initial description" } |
Response | 201
|
DELETE /kwatee/api/artifacts/{artifactName}
Deletes an artifact. The operation is successful even if the artifact does not exist.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of an artifact | String |
true |
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | DELETE http://kwatee.local:8080/kwate/api/artifacts/testArtifact
|
Response | 200
|
GET /kwatee/api/artifacts/{artifactName}/{versionName}.json
Retrieves the properties of an artifact's version.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
Returns application/json
version object
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0.json
|
Response | 200
{ "name" : "1.0", "description" : "initial release", "frozen" : true, "platforms" : [ 1, 2, 7 ], "packageInfo" : { "name" : "mywebsite.zip", "size" : "10.0 KB" }, "executables" : [ ], "varPrefixChar" : 37 } |
PUT /kwatee/api/artifacts/{artifactName}/{versionName}
Updates an artifact's version properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
RequestBody | versionProperties | the JSON version properties | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0
{ "description" : "new description" } |
Response | 200
|
POST /kwatee/api/artifacts/{artifactName}/{versionName}
Creates or duplicates a version in an artifact and optionally set additional properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of the version to create | String |
true |
RequestParam | duplicateFrom | the optional name of a version to duplicate | String |
false |
RequestBody | versionProperties | the optional JSON version properties | String |
true |
201
created401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorDuplicate existing version 1.0
Request | POST http://kwatee.local:8080/kwate/api/artifacts/demowebsite/2.0?duplicateFrom=1.0
{ "description" : "duplicated from version 1.0" } |
Response | 201
|
DELETE /kwatee/api/artifacts/{artifactName}/{versionName}
Deletes an artifact's version. The operation is successful even if the version does not exist.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | DELETE http://kwatee.local:8080/kwate/api/artifacts/demowebsite/2.0
|
Response | 200
|
POST /kwatee/api/artifacts/{artifactName}/{versionName}/package
Uploads a package to an artifact's version.
Replaces whatever existing package there is but retains previously uploaded overlays unless deleteOverlays=true
. The package may be supplied as a multipart POST content or as a url.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
RequestParam | file | the optional package file to upload as POST data | MultipartFile |
false |
RequestParam | url | the optional package url (can be file:///) of package to upload | String |
false |
RequestParam | deleteOverlays |
if true , removes pre-existing overlays (false if omitted)
|
boolean |
false |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0
multipart/form-data: ...Content-Disposition: form-data; name="file";filename="newarchive.tar.gz" |
Response | 200
|
GET /kwatee/api/artifacts/{artifactName}/{versionName}/package/files.json
Retrieves the files present in a version's package at a given relative path.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
RequestParam | path | the relative path of the directory to list within package (if omitted, root of the package) | String |
false |
Returns application/json
array of file objects
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0/package/files.json
|
Response | 200
[ { "id" : 1, "name" : "index.php", "hasVariables" : true }, { "id" : 2, "name" : "logo.gif" } ] |
GET /kwatee/api/artifacts/{artifactName}/{versionName}/package/specialFiles.json
Retrieves all the special files within the package. Files with custom properties, containing variables or overlays are considered "special".
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
Returns application/json
array of file objects
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0/package/specialFiles.json
|
Response | 200
[ { "id" : 1, "name" : "index.php", "hasVariables" : true, "path" : "index.php" } ] |
PUT /kwatee/api/artifacts/{artifactName}/{versionName}/package/file
Updates custom flags of a file within a package.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
RequestParam | path | the relative path of the file within the package | String |
false |
RequestBody | fileProperties | the JSON file's properties to update | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0/package/file?path=index.php
{ "ignoreVariables" : true } |
Response | 200
|
GET /kwatee/api/artifacts/{artifactName}/{versionName}/package/file
Downloads a file within the package in the specified location.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
RequestParam | path | the relative path of the file within the package | String |
false |
Returns text/plain
or application/octet-stream
file contents
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0/package/file?path=index.php
|
Response | 200
|
POST /kwatee/api/artifacts/{artifactName}/{versionName}/package/overlay
Uploads an overlay at a relative path within the package.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
RequestParam | path | the relative path of the overlay directory within the package | String |
false |
RequestParam | file | optional overlay file to upload as POST data | MultipartFile |
false |
RequestParam | url | optional overlay file url or overlay file path of file to upload | String |
false |
201
created401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorUpload an overlay at the root of the archive named 'logo.gif'
Request | POST http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0/package/overlay
|
Response | 201
|
DELETE /kwatee/api/artifacts/{artifactName}/{versionName}/package/overlay
Deletes an existing version overlay.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
RequestParam | path | the relative path of the file within the package | String |
false |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | DELETE http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0/package/overlay?path=logo.gif
|
Response | 200
|
GET /kwatee/api/artifacts/{artifactName}/{versionName}/variables.json
Retrieves the list of version variables.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
Returns application/json
array of version variable objects
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0/variables.json
|
Response | 200
[ { "name" : "CUSTOMER_NAME", "reference" : [ "demowebsite - index.php" ] } ] |
PUT /kwatee/api/artifacts/{artifactName}/{versionName}/variables
Sets version variables.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | artifactName | the name of the version's artifact | String |
true |
PathVariable | versionName | the name of a version | String |
true |
RequestBody | variables | a JSON array of variable objects | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/artifacts/demowebsite/1.0/variables
[ { "name" : "CUSTOMER_NAME", "value" : "ACME Corp." } ] |
Response | 200
|
POST /kwatee/api/artifacts
Uploads an artifacts bundle into the repository.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
RequestParam | file | optional bundle file to upload as POST data | MultipartFile |
false |
RequestParam | url | optional bundle url or bundle file path of file to upload | String |
false |
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/artifacts/
multipart/form-data: ...Content-Disposition: form-data; name="file";filename="bundle.kw" |
Response | 200
|
GET /kwatee/api/servers.json
Retrieves the list of servers in the repository
Returns application/json
array of server objects
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/servers.json
|
Response | 200
[ { "name" : "demoserver", "description" : "Demo server" } ] |
GET /kwatee/api/servers/{serverName}.json
Retrieves server properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | serverName | the name of the server | String |
true |
Returns application/json
server object
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/servers/demoserver.json
|
Response | 200
{ "name" : "demoserver", "description" : "Demo server", "platform" : 2, "conduitType" : "ssh", "ipAddress" : "demo.kwatee.net", "port" : 22, "credentials" : { "login" : "kwtest" }, "properties" : { }, "poolConcurrency" : 0 } |
PUT /kwatee/api/servers/{serverName}
Updates the properties of a server.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | serverName | the name of the server | String |
true |
RequestBody | serverProperties | the JSON server properties to update | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/servers/demoserver
|
Response | 200
|
POST /kwatee/api/servers/{serverName}
Creates or duplicates a server and optionally set additional properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | serverName | the name of the server to create | String |
true |
RequestParam | duplicateFrom | the optional name of a server to duplicate | String |
false |
RequestBody | serverProperties | the optional JSON server properties | String |
true |
201
created401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/servers/newserver
|
Response | 201
|
DELETE /kwatee/api/servers/{serverName}
Deletes a server. The operation is successful even if the server does not exist.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | serverName | the name of the server | String |
true |
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | DELETE http://kwatee.local:8080/kwate/api/servers/newserver
|
Response | 200
|
POST /kwatee/api/servers/{serverName}/testConnection
Tests a connection to the server and returns server capabilities.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | serverName | the name of the server | String |
true |
RequestBody | json | String |
true |
Returns application/json
array of server capabilities
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/servers/demoserver
|
Response | 200
[ "Test platform command availability (support=0 is good)", "cd support=0", "chmod support=0", "mkdir support=0", "rm support=0", "cat support=0" ] |
GET /kwatee/api/environments.json
Retrieves the list of environments in the repository.
Returns application/json
array of environment objects
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/environments.json
|
Response | 200
[ { "name" : "intro", "description" : "introductory tutorial" } ] |
GET /kwatee/api/environments/{environmentName}.json
Retrieves an environment's properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the environment | String |
true |
Returns application/json
environment object
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/environments/intro.json
|
Response | 200
{ "name" : "intro", "description" : "introductory tutorial", "artifacts" : [ "demowebsite" ], "servers" : [ "demoserver" ], "sequentialDeployment" : true, "releases" : [ { "name" : "snapshot", "editable" : true }, { "name" : "acme-1.0", "description" : "initial deployment" } ] } |
PUT /kwatee/api/environments/{environmentName}
Updates the environment with new properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of an environment | String |
true |
RequestBody | environmentProperties | the JSON environment properties to update | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/environments/intro
{ "description" : "new description" } |
Response | 200
|
POST /kwatee/api/environments/{environmentName}
Creates or duplicates an environment and optionally set additional properties.
Note that only the snapshot environment is included in a duplicate operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the environment to create | String |
true |
RequestParam | duplicateFrom | the optional name of an environment to duplicate | String |
false |
RequestBody | environmentProperties | the optional JSON environment properties | String |
true |
201
created401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/environments/testEnvironment
{ "description" : "initial description" } |
Response | 201
|
DELETE /kwatee/api/environments/{environmentName}
Deletes an environment. The operation is successful even if the environment does not exist.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of an environment | String |
true |
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | DELETE http://kwatee.local:8080/kwate/api/environments/testEnvironment
|
Response | 200
|
GET /kwatee/api/environments/{environmentName}/{releaseName}.json
Retrieve an environment's release properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
Returns application/json
release object
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/environments/intro/snapshot.json
|
Response | 200
{ "name" : "snapshot", "editable" : true, "defaultArtifacts" : [ { "name" : "demowebsite", "version" : "1.0" } ], "serverArtifacts" : [ { "artifacts" : [ { "name" : "demowebsite" } ], "server" : "demoserver" } ] } |
PUT /kwatee/api/environments/{environmentName}/{releaseName}
Updates a release with new properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestBody | json | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/environments/intro/snapshot
{ "description" : "new description" } |
Response | 200
|
POST /kwatee/api/environments/{environmentName}/{releaseName}
Tags a release and optionally sets additional properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of tagged release to create | String |
true |
RequestBody | releaseProperties | the optional JSON release properties to set | String |
true |
201
created401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/environments/intro/newtag
{ "description" : "tagged on Oct 5, 2014" } |
Response | 201
|
DELETE /kwatee/api/environments/{environmentName}/{releaseName}
Deletes a release. The operation is successful even if the release does not exist.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | DELETE http://kwatee.local:8080/kwate/api/environments/intro/newtag
|
Response | 200
|
POST /kwatee/api/environments/{environmentName}/{releaseName}/reedit
Reedits a previously tagged release.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/environments/intro/newtag/reedit
|
Response | 200
|
GET /kwatee/api/environments/{environmentName}/{releaseName}/artifacts.json
Retrieves the effective release artifacts.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
Returns application/json
array of release artifact objects
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/environments/intro/snapshot/artifacts.json
|
Response | 200
[ { "artifact" : "demowebsite", "version" : "1.0" } ] |
PUT /kwatee/api/environments/{environmentName}/{releaseName}/activeVersion
Sets the active version (default of server-specific) of a release artifact.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | artifactName | the name of an artifact | String |
true |
RequestParam | versionName | the active version to be set | String |
true |
RequestParam | serverName | an optional server name (omit to set default active version) | String |
false |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/environments/intro/snapshot/activeVersion?artifactName=demowebsite&versionName=1.0
|
Response | 200
|
GET /kwatee/api/environments/{environmentName}/{releaseName}/package/files.json
Retrieves the files present in an release artifact package at a given relative path within the package.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | artifactName | the name of an artifact | String |
false |
RequestParam | serverName | an optional server name (omit for listing files common to all servers overlays) | String |
false |
RequestParam | path | the optional relative path of the directory to list within package (omit for full recursive listing) | String |
false |
Returns application/json
array of file objects
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/environments/intro/snapshot/package/files.json?artifactName=demowebsite
|
Response | 200
[ { "id" : 1, "name" : "index.php", "hasVariables" : true }, { "id" : 2, "name" : "logo.gif" } ] |
GET /kwatee/api/environments/{environmentName}/{releaseName}/package/specialFiles.json
Retrieves all the special files within the release artifact package. Files with custom properties, containing variables or overlays are considered "special".
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | artifactName | the name of an artifact | String |
false |
RequestParam | serverName | an optional server name (omit for listing files common to all servers overlays) | String |
false |
Returns application/json
array of file objects
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/environments/intro/snapshot/package/specialFiles.json?artifactName=demowebsite
|
Response | 200
[ { "id" : 1, "name" : "index.php", "hasVariables" : true }, { "id" : 2, "name" : "logo.gif" } ] |
PUT /kwatee/api/environments/{environmentName}/{releaseName}/package/file
Update custom flags of a file within a release artifact package.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | artifactName | the name of an artifact | String |
false |
RequestParam | serverName | an optional server name (omit for making changes common to all servers) | String |
false |
RequestParam | path | the relative path of the file within the package | String |
false |
RequestBody | fileProperties | the JSON file properties to update | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/environments/intro/snapshot/package/file?artifactName=demowebsite&path=index.php
{ "ignoreVariables" : true } |
Response | 200
|
GET /kwatee/api/environments/{environmentName}/{releaseName}/package/file
Downloads a file within the release artifact package.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | artifactName | the name of an artifact | String |
false |
RequestParam | serverName | an optional server name (omit for referring to common environment file) | String |
false |
RequestParam | path | the relative path of the file within the package | String |
false |
Returns text/plain
or application/octet-stream
contents of the file
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/environments/intro/snapshot/package/file?artifactName=demowebsite&path=index.php
|
Response | 200
|
POST /kwatee/api/environments/{environmentName}/snapshot/package/overlay
Uploads an overlay at a relative path within the release artifact package.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
RequestParam | artifactName | the name of an artifact | String |
false |
RequestParam | serverName | an optional server name (omit for referring to common environment file) | String |
false |
RequestParam | path | the relative path of the overlay directory within the package | String |
false |
RequestParam | file | optional overlay file to upload as POST data | MultipartFile |
false |
RequestParam | url | optional overlay file url or overlay file path of file to upload | String |
false |
201
created401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/environments/intro/snapshot/package/overlay?artifactName=demowebsite
multipart/form-data: ...Content-Disposition: form-data; name="file";filename="logo.gif" |
Response | 201
|
DELETE /kwatee/api/environments/{environmentName}/snapshot/package/overlay
Deletes an existing release artifact package overlay.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
RequestParam | artifactName | the name of an artifact | String |
false |
RequestParam | serverName | an optional server name (omit for referring to common environment file) | String |
false |
RequestParam | path | the relative path of the file within the package | String |
false |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | DELETE http://kwatee.local:8080/kwate/api/environments/intro/snapshot/package/overlay?artifactName=demowebsite&path=logo.gif
|
Response | 200
|
GET /kwatee/api/environments/{environmentName}/{releaseName}/variables.json
Retrieves release variables.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
Returns application/json
array of variable objects
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/environments/intro/snapshot/variables.json
|
Response | 200
{ "variables" : [ { "name" : "CUSTOMER_NAME", "value" : "ACME Corp." }, { "name" : "kwatee_deployment_dir", "description" : "Default deployment directory", "artifact" : "demowebsite", "value" : "/Library/WebServer/Documents" } ], "globalVariables" : [ { "name" : "kwatee_root_dir", "description" : "Kwatee agent and metadata directory", "value" : "/var/tmp/kwatee" }, { "name" : "kwatee_deployment_dir", "description" : "Default deployment directory", "value" : "/var/tmp/kwateetest/%{kwatee_environment_name}" }, { "name" : "kwatee_package_dir", "description" : "Default deployment artifact directory", "value" : "%{kwatee_deployment_dir}/%{kwatee_package_name}" } ] } |
PUT /kwatee/api/environments/{environmentName}/{releaseName}/variables
Sets the release variables.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestBody | variables | a JSON array of variable objects | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | PUT http://kwatee.local:8080/kwate/api/environments/intro/snapshot/variables
[ { "name" : "CUSTOMER_NAME", "value" : "test" } ] |
Response | 200
|
GET /kwatee/api/deployments.json
Retrieves the list of deployments.
Returns application/json
array of deployments objectes
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments.json
|
Response | 200
[ { "name" : "intro", "description" : "introductory tutorial", "releases" : [ { "name" : "snapshot", "editable" : true }, { "name" : "acme-1.0", "description" : "initial deployment" } ] } ] |
GET /kwatee/api/deployments/{environmentName}/{releaseName}.json
Retrieves the deployment properties.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
Returns application/json
deployment object
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/intro/snapshot.json
|
Response | 200
{ "name" : "snapshot", "serverArtifacts" : [ { "artifacts" : [ { "name" : "demowebsite", "version" : "1.0" } ], "server" : "demoserver" } ], "editable" : true } |
GET /kwatee/api/deployments/{environmentName}/{releaseName}.tar.gz
Downloads a self-contained command-line installer (to install one server at a time).
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
Returns application/x-gtar
installer
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/intro/snapshot.tar.gz
|
Response | 200
|
GET /kwatee/api/deployments/{environmentName}/{releaseName}.kw
Downloads an installer.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
Returns application/octet-stream
installer
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/intro/snapshot.kw
|
Response | 200
|
POST /kwatee/api/deployments/{environmentName}/{releaseName}/deploy
Initiates a deploy operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | serverName | the optional name of a server (omit to perform operation on all environment servers) | String |
false |
RequestParam | artifactName | the optional name of an artifact (omit to perform operation on all environment artifacts) | String |
false |
Returns application/json
deployment operation reference
202
accepted401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/deployments/intro/deploy
|
Response | 202
{ "ref" : "1:1417387427690" } |
POST /kwatee/api/deployments/{environmentName}/{releaseName}/undeploy
Initiates an undeploy operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | serverName | the optional name of a server (omit to perform operation on all environment servers) | String |
false |
RequestParam | artifactName | the optional name of an artifact (omit to perform operation on all environment artifacts) | String |
false |
RequestParam | forcedUndeploy |
when true forces undeploy even if there are errors (false if omitted)
|
boolean |
false |
Returns application/json
deployment operation reference
202
accepted401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/deployments/intro/undeploy
|
Response | 202
{ "ref" : "1:1417387427690" } |
POST /kwatee/api/deployments/{environmentName}/{releaseName}/check
Initiates a check integrity operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | serverName | the optional name of a server (omit to perform operation on all environment servers) | String |
false |
RequestParam | artifactName | the optional name of an artifact (omit to perform operation on all environment artifacts) | String |
false |
Returns application/json
deployment operation reference
202
accepted401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/deployments/intro/check
|
Response | 202
{ "ref" : "1:1417387427690" } |
POST /kwatee/api/deployments/{environmentName}/{releaseName}/start
Initiates a start executables operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | serverName | the optional name of a server (omit to perform operation on all environment servers) | String |
false |
RequestParam | artifactName | the optional name of an artifact (omit to perform operation on all environment artifacts) | String |
false |
Returns application/json
deployment operation reference
202
accepted401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/deployments/intro/start
|
Response | 202
{ "ref" : "1:1417387427690" } |
POST /kwatee/api/deployments/{environmentName}/{releaseName}/stop
Initiates a stop executables operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | serverName | the optional name of a server (omit to perform operation on all environment servers) | String |
false |
RequestParam | artifactName | the optional name of an artifact (omit to perform operation on all environment artifacts) | String |
false |
Returns application/json
deployment operation reference
202
accepted401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/deployments/intro/stop
|
Response | 202
{ "ref" : "1:1417387427690" } |
POST /kwatee/api/deployments/{environmentName}/{releaseName}/status
Initiates an executables status operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
PathVariable | environmentName | the name of the release's environment | String |
true |
PathVariable | releaseName | the name of the release | String |
true |
RequestParam | serverName | the optional name of a server (omit to perform operation on all environment servers) | String |
false |
RequestParam | artifactName | the optional name of an artifact (omit to perform operation on all environment artifacts) | String |
false |
Returns application/json
deployment operation reference
202
accepted401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/deployments/intro/status
|
Response | 202
{ "ref" : "1:1417387427690" } |
GET /kwatee/api/deployments/ongoing.json
Retrieves an ongoing deployment operation.
Returns application/json
deployment operation reference
202
accepted401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/ongoing.json
|
Response | 200
{ "ref" : "1:1417387427690" } |
GET /kwatee/api/deployments/progress/status
Is an ongoing operation in progress?
Name | Description | Type | Mandatory | |
---|---|---|---|---|
RequestParam | ref | the reference of an ongoing deployment operation | String |
false |
200
the operation completed successfully204
the operation has not completed yet400
the operation has completed but failed410
the operation is gone401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/progress/status
|
Response | 200
|
GET /kwatee/api/deployments/progress/status.json
Retrieves the progress of a deployment operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
RequestParam | ref | the reference of an ongoing deployment operation | String |
false |
Returns application/json
deployment operation progress
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/progress/status.json?ref=1:1417387427690
|
Response | 200
{ "operation" : "deploy", "status" : "done", "servers" : [ { "name" : "demoserver", "status" : "ok", "artifacts" : [ { "name" : "demowebsite", "status" : "ok" } ] } ] } |
GET /kwatee/api/deployments/progress/messages.json
Retrieves the details of a deployment operation for a given server and or artifact.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
RequestParam | ref | the reference of an ongoing deployment operation | String |
false |
RequestParam | serverName | the name of the server for which info is requested | String |
false |
RequestParam | artifactName | the optional name of an artifact for which info is requested (if omitted, only server-wide info is returned) | String |
false |
Returns application/json
deployment operation details object
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/progress/messages.json?ref=1:1417387427690&serverName=demoserver
|
Response | 200
{ "messages" : "Establishing server connection...\nConnection established\nDeploy of artifact demowebsite[1.0] in intro-snapshot@demoserver\nDeploy complete" } |
POST /kwatee/api/deployments/progress/cancel
Cancels an ongoing operation.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
RequestParam | ref | the reference of an ongoing deployment operation | String |
false |
RequestParam | dontClear |
if true the status is kept active
|
boolean |
false |
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/deployments/progress/cancel?ref=1:1417387427690
|
Response | 200
|
POST /kwatee/api/deployments/progress/credentials
Supply server credentials without storing them in kwatee.
Name | Description | Type | Mandatory | |
---|---|---|---|---|
RequestParam | environmentName | the name of an environment | String |
false |
RequestParam | serverName | the name of the server | String |
false |
RequestParam | sameForAll |
optional, if true , these same credentials will be applied to all servers that need it.
|
boolean |
false |
RequestBody | credentials | the optional JSON credentials | String |
true |
200
success401
authentication token missing or expired404
not found420
unspecified kwatee error (check logs)500
internal errorRequest | POST http://kwatee.local:8080/kwate/api/deployments/progress/credentials?environmentName=intro&deploymentName=snapshot
{ "login" : "kwtest", "password" : "password" } |
Response | 200
|
GET /kwatee/api/info/context.json
Retrieves kwatee information.
Returns application/json
kwatee context object
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/info/context.json
|
Response | 200
{ "organization" : "<your organisation name here>", "version" : "Version 2.3.0", "user" : "admin", "copyright" : "Copyright 2010-2014" } |
GET /kwatee/api/info/platforms.json
Retrieves the available platforms.
Returns application/json
array of platform objects
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/info/platforms.json
|
Response | 200
[ { "id" : 1, "name" : "linux_x86" }, { "id" : 7, "name" : "linux_64" }, { "id" : 3, "name" : "solaris_x86" }, { "id" : 4, "name" : "solaris_sparc" }, { "id" : 2, "name" : "macosx_x86" }, { "id" : 8, "name" : "aix" }, { "id" : 5, "name" : "win32" }, { "id" : 9, "name" : "win64" } ] |
GET /kwatee/api/info/conduitTypes.json
Retrieves the available conduit types.
Returns application/json
array of conduit type objects
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/info/conduitTypes.json
|
Response | 200
[ { "id" : "telnetftp", "name" : "Telnet / FTP" }, { "id" : "ssh", "name" : "Secure Shell / scp" } ] |
GET /kwatee/api/info/serverPoolTypes.json
Retrieves the available server pool types.
Returns application/json
array of server pool type objects in case of success
200
success401
authentication token missing or expired420
unspecified kwatee error (check logs)500
internal errorRequest | GET http://kwatee.local:8080/kwate/api/deployments/info/serverPoolTypes.json
|
Response | 200
[ { "id" : "manual", "name" : "Enumerated pool" }, { "id" : "ec2", "name" : "Amazon EC2 pool" } ] |