summary	tags	locale	guid	app_type	platform-version	figma
Allows you to manage applications, modules, environments and deployments of your OutSystems infrastructure. Version 2 of the API adds support for deployment zones, users, teams, and roles.		en-us	8ebd5215-2960-4071-8a9c-83fe39674ee0	traditional web apps, mobile apps, reactive web apps	o11	https://www.figma.com/file/eFWRZ0nZhm5J5ibmKMak49/Reference?node-id=609:507

LifeTime API v2

The LifeTime API allows you to manage applications, modules, environments, and deployments of your OutSystems infrastructure. Version 2 of the API adds support for deployment zones, users, teams, and roles.

Follow the guidelines presented in REST API Authentication to authenticate your API requests.

Check LifeTime API Examples to learn how to perform common tasks using the LifeTime API.

You can download the Swagger file for the LifeTime API v2 in the download page of LifeTime Management Console binaries (available from LifeTime Management Console 11.5.0). Go to the Downloads area, and select your LifeTime Management Console version:

Summary {#swagger--summary-tags}

The LifeTime API is available through your LifeTime environment, with the API base URL determined by your LifeTime environment's domain. For instance, if your LifeTime address is example-lt.outsystemsenteprise.com/lifetime, then the LifeTime API base URL is example-lt.outsystemsenteprise.com/lifetimeapi/rest/v2.

You can also find and test LifeTime API v2 in Postman.

Base URL : <lifetime-domain>/lifetimeapi/rest/v2

Version : v2

Scheme : https

/applications

Endpoint	Description
GET /applications/	Returns a list of applications that exist in the infrastructure.
GET /applications/{ApplicationKey}/	Returns the details of a given application.
GET /applications/{ApplicationKey}/versions/	Returns a list of versions of a given application.
DELETE /applications/{ApplicationKey}/versions/{VersionKey}/	Discards an application version, if possible. Running versions, or versions used in Deployments cannot be deleted.
GET /applications/{ApplicationKey}/versions/{VersionKey}/	Returns the details of a given version of the specified application.
GET /applications/{ApplicationKey}/versions/{VersionKey}/content/	Returns a link where the binary file for a given application version can be downloaded. The link will expire in 60 minutes.

/environments

Endpoint	Description
GET /environments/	Lists all the environments in the infrastructure.
POST /environments/	Registers an environment in LifeTime. This endpoint is available as of LifeTime Management Console 11.11.0.
GET /environments/{EnvironmentKey}/	Returns the details of a given environment.
DELETE /environments/{EnvironmentKey}/	Unregisters an environment from LifeTime. This endpoint is available as of LifeTime Management Console 11.11.0.
GET /environments/{EnvironmentKey}/applications/	Returns information about the running versions of all applications in a given environment.
POST /environments/{EnvironmentKey}/applications/	Creates a new application in the environment. This endpoint is available as of LifeTime Management Console 11.5.0.
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/	Returns information about the running version of the specified application in a given environment.
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/content/	Returns a link where the binary file for a given application can be downloaded. The link will expire in 60 minutes.
POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/	Creates a new version of the application based on the current running application.
GET /environments/{EnvironmentKey}/deploymentzones/	Returns information about the deployment zones available in a given environment.
GET /environments/{EnvironmentKey}/templates/	Returns information about the templates available in a given environment. This endpoint is available as of LifeTime Management Console 11.5.0.
GET /environments/{EnvironmentKey}/content_security_policies/	Returns information about the Content Security Policy in a given environment. This endpoint is available as of LifeTime Management Console 11.10.3.
PUT /environments/{EnvironmentKey}/content_security_policies/	Sets the Content Security Policies for a given environment. This endpoint is available as of LifeTime Management Console 11.10.3.
GET /environments/{EnvironmentKey}/dbconnections/	Returns all the DB connections of a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.
POST /environments/{EnvironmentKey}/dbconnections/	Creates a new DB connection for an environment. This endpoint is available as of LifeTime Management Console 11.13.0.
GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/	Returns the detail of a DB Connection for a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.
PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/	Updates a DB connection for an environment. This endpoint is available as of LifeTime Management Console 11.13.0.
DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/	Deletes a DB connection for an environment. This endpoint is available as of LifeTime Management Console 11.13.0.
PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/	Sets the DB connection permission levels for a Role in a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.
DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/	Revokes the DB connection permissions for a Role in an environment. This endpoint is available as of LifeTime Management Console 11.13.0.
GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/{Role}/	Returns the DB connection permission level of a Role for a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.
PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/	Sets the DB connection permission levels for a User in a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.
DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/	Revokes the DB connection permissions for a User in an environment. This endpoint is available as of LifeTime Management Console 11.13.0.
GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/{Username}/	Returns the DB connection permission level of a User for a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.
GET /environments/{EnvironmentKey}/dbconnection/dbproviders/	Returns the list of providers for all the DB connections in a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.
GET /environments/dbconnection/permissionlevels/	Returns the permission levels for the DB connections. This endpoint is available as of LifeTime Management Console 11.13.0.
POST /environments/{EnvironmentKey}/testdbconnection/	Tests the DB connection. This endpoint is available as of LifeTime Management Console 11.13.0.
GET /environments/blockedipaddresses/	Gets the IP Addresses blocked login attempts. This endpoint is available as of LifeTime Management Console 11.13.0.
DELETE /environments/blockedipaddresses/{IPAddress}/	Unblocks a given IP Address. This endpoint is available as of LifeTime Management Console 11.13.0.

/deployments

Endpoint	Description
POST /deployments/	Creates a deployment to a target environment. An optional list of applications to include in the deployment can be specified. The input is a subset of deployment object.
GET /deployments/	Returns a list of deployments ordered by creation date, from newest to oldest.
DELETE /deployments/{DeploymentKey}/	Discards a deployment, if possible. Only deployments whose state is “saved” can be deleted.
PUT /deployments/{DeploymentKey}/	Updates a given deployment. An optional list of applications to include in the deployment can be specified. The input is a subset of deployment object.
GET /deployments/{DeploymentKey}/	Returns the details of a given deployment. The returned information contains the included applications and the possible conflicts that can arise from the deployment of the current applications.
POST /deployments/{DeploymentKey}/{Command}/	Executes the given command in a specified deployment. The allowed commands are “start”, “continue” and “abort”.
GET /deployments/{DeploymentKey}/status/	Returns the details of a given deployment execution, including the deployment status and messages.

/modules

Endpoint	Description
GET /modules/	Returns a list of modules that exist in the infrastructure.
GET /modules/{ModuleKey}/	Returns the details of a given module.
GET /modules/{ModuleKey}/versions/	Returns a list of versions of a given module.
GET /modules/{ModuleKey}/versions/{ModuleVersionKey}/	Returns the details of a given module version.

/roles

Available as of LifeTime Management Console 11.5.0.

Endpoint	Description
GET /roles/	Lists all the roles.
POST /roles/	Creates a role with the specified permissions.
GET /roles/{RoleKey}/	Returns the details of a given role.
PUT /roles/{RoleKey}/	Updates a role with the specified permissions.
DELETE /roles/{RoleKey}/	Deletes a role.
GET /roles/permissionlevels/	Gets available permission levels.

/teams

Available as of LifeTime Management Console 11.5.0.

Endpoint	Description
GET /teams/	Lists all the teams.
POST /teams/	Creates a team with the specified details. The operation only creates the team. Users and Applications should be associated using specific endpoints.
GET /teams/{TeamKey}/	Returns the details of a given team.
PUT /teams/{TeamKey}/	Updates a team with the specified details. The operation only affects the Team details. Users and Applications should be associated or dissociated using specific endpoints.
DELETE /teams/{TeamKey}/	Deletes a team.
POST /teams/{TeamKey}/applications/	Adds the specified application to a given team. The operation adds an existing application to the team. To create a new application, use POST /environments/{EnvironmentKey}/applications/.
DELETE /teams/{TeamKey}/applications/{ApplicationKey}	Removes application from the given team.
POST /teams/{TeamKey}/users/	Adds a user to a team with a specified role.
DELETE /teams/{TeamKey}/users/{UserKey}/	Removes a user from the given team.

/users

Available as of LifeTime Management Console 11.5.0.

Endpoint	Description
GET /users/	Lists all the users. By default shows only active users.
POST /users/	Creates a user with the specified details. The operation only creates the user. Teams and Applications should be associated using specific endpoints.
GET /users/{UserKey}/	Returns the details of a given user.
PUT /users/{UserKey}/	Updates a user with the specified details. The operation only updates the user details. Teams and Applications should be associated using specific endpoints.
POST /users/{UserKey}/setpassword/	Allows to change a password of a given user.
POST /users/{UserKey}/applications/	Grants a given role to the given application to the user.
DELETE /users/{UserKey}/applications/{ApplicationKey}/	Revokes user's role in application permission.
GET /users/{UserKey}/blockedlogins/	Gets the users blocked login attempts. This endpoint is available as of LifeTime Management Console 11.13.0.
DELETE /users/{UserKey}/blockedlogins/	Unblocks a given user. This endpoint is available as of LifeTime Management Console 11.13.0.

Endpoints

GET /applications/

Go to /applications

Returns a list of applications that exist in the infrastructure.


IncludeModules	When set to true, the modules are also returned. The default value is false.	query	boolean
IncludeEnvStatus	When set to true, the application status per environment is also returned. The default value is false.	query	boolean

application/json

200 OK: Applications list successfully retrieved.

A list of Application records including AppStatusInEnv sub-lists, if requested.

Application
204 No Content: No applications available in the infrastructure.
400 Bad Request: Failed to retrieve applications because IncludeModules was requested but IncludeEnvStatus was not, or invalid request when listing all applications.

Exception
500 Internal Server Error: Failed to list the applications.

Exception

GET /applications/{ApplicationKey}/

Go to /applications

Returns the details of a given application.


ApplicationKey	The key of the desired application.	path	string
IncludeModules	When set to true, the modules details are also retrieved. The default value is false.	query	boolean
IncludeEnvStatus	When set to true, the application status per environment is also returned. The default value is false.	query	boolean

application/json

200 OK: An Application record including an AppStatusInEnv sub-list, if requested.

Application
400 Bad Request: Failed to retrieve applications because IncludeModules and IncludeEnvStatus parameters were incorrect.

Exception
403 Forbidden: Failed listing all applications because user has insufficient permissions.

Exception
404 Not Found: Failed getting running applications because one of the environments was not found.

Exception
500 Internal Server Error: Failed to retrieve the application.

Exception

GET /applications/{ApplicationKey}/versions/

Go to /applications

Returns a list of versions of a given application.


ApplicationKey	The key of the desired application.	path	string
ChangeLogFilter	Optional filter. If present, only versions containing this string in the change log will be returned.	query	string
MaximumVersionsToReturn	The maximum number of versions to return. The default value is 5.	query	integer (int32)

application/json

200 OK: Application versions list successfully retrieved.

A list of ApplicationVersion records.

ApplicationVersion_v2
400 Bad Request: Invalid request due to invalid max versions to return (less than 0).

Exception
403 Forbidden: Failed to retrieve the application with key <ApplicationKey>. The user does not have the required permissions.

Exception
404 Not Found: Failed to retrieve the application with key <ApplicationKey>.

Exception
500 Internal Server Error: Failed to list the application versions.

Exception

DELETE /applications/{ApplicationKey}/versions/{VersionKey}/

Go to /applications

Discards an application version, if possible. Running versions, or versions used in Deployments cannot be deleted.


ApplicationKey	The key of the application whose version to be deleted.	path	string
VersionKey	The key of the application version to be deleted.	path	string

204 No Content: Application version successfully deleted.
403 Forbidden: Service Account doesn't have permissions to delete the specified application version.

Exception
404 Not Found: Application or application version not found.

Exception
500 Internal Server Error: Failed to delete application version <VersionKey>.

Exception

GET /applications/{ApplicationKey}/versions/{VersionKey}/

Go to /applications

Returns the details of a given version of the specified application.


ApplicationKey	The key of the application whose version is being requested.	path	string
IncludeModules	When set to true, the modules details are also retrieved. The default value is false.	query	boolean
VersionKey	The key of the desired application version.	path	string

application/json

200 OK: An ApplicationVersion record.

ApplicationVersion_v2
403 Forbidden: Failed to retrieve the application with key <ApplicationKey>. The user does not have the required permissions.

Exception
404 Not Found: Failed to retrieve the application with key <ApplicationKey>.

Exception
500 Internal Server Error: Failed to retrieve the application version.

Exception

GET /applications/{ApplicationKey}/versions/{VersionKey}/content/

Go to /applications

Returns a link where the binary file for a given application version can be downloaded. The link will expire in 60 minutes.


ApplicationKey	The key of the application for which to get the binary file link.	path	string
VersionKey	The key of the application version for which to get the binary file link.	path	string

application/json

200 OK

The link for the application binary file.

DownloadLink


Expires	The expiration date and time of the returned link.	string(date-time)

204 No Content

No binary available for given keys.

400 Bad Request

The request is invalid for the given keys (Application:<ApplicationKey>; ApplicationVersionKey <ApplicationVersionKey>).

Exception

403 Forbidden

User doesn't have permissions for the given keys (Application:<ApplicationKey>; ApplicationVersionKey <ApplicationVersionKey>).

Exception

404 Not Found

Failed to retrieve the application with key <ApplicationKey> or the application version with key <ApplicationVersionKey>.

Exception

500 Internal Server Error

Failed to download the oap of the application version.

Exception

GET /deployments/

Go to /deployments

Returns a list of deployments ordered by creation date, from newest to oldest.


MinDate	The minimum creation date of the deployments to return. The default value is 1 week before the current date.	query	string (date)
MaxDate	The maximum creation date of the deployments to return. The default value is the current date.	query	string (date)
TargetEnvironmentKey	The key of the target environment to return the deployments from. If the user does not have access to the environment, the list returned will be empty. If no environment key is passed, the list will not be filtered by any target environment.	query	string

application/json

200 OK: Deployments list successfully retrieved.

A list of Deployment records.

Deployment_v2
204 No Content: There are no deployments created between <MinDate> and <MaxDate> for environment key <TargetEnvironmentKey>.
400 Bad Request: Invalid request for list of deployments created between <MinDate> and <MaxDate> for environment key <TargetEnvironmentKey>.

Exception
403 Forbidden: User doesn't have access to any environment.

Exception
500 Internal Server Error: Failed to list the deployments.

Exception

POST /deployments/

Go to /deployments

Creates a deployment to a target environment. An optional list of applications to include in the deployment can be specified. The input is a subset of deployment object.

application/json

A Deployment record.

ApplicationVersionKeyDeploymentZoneKeyRecordListTextTextTextRecord

text/plain

200 OK: Deployment successfully created.

The key of the newly created deployment.
400 Bad Request: Invalid request.

Exception
403 Forbidden: Invalid user permissions.

Exception
404 Not Found: Source or target environment not found.

Exception
500 Internal Server Error: Failed to create deployment from environment <SourceEnvironmentKey> to environment <TargetEnvironmentKey>.

Exception

DELETE /deployments/{DeploymentKey}/

Go to /deployments

Discards a deployment, if possible. Only deployments whose state is “saved” can be deleted.


DeploymentKey	The key of the deployment to delete.	path	string

204 No Content: Deployment successfully deleted.
400 Bad Request: Deployment with key <DeploymentKey> cannot be deleted

Exception
403 Forbidden: Service Account doesn't have permissions to the deployment with key <DeploymentKey>.

Exception
404 Not Found: Deployment with key <DeploymentKey> not found.

Exception
500 Internal Server Error: Failed to delete deployment <DeploymentKey>.

Exception

GET /deployments/{DeploymentKey}/

Go to /deployments

Returns the details of a given deployment. The returned information contains the included applications and the possible conflicts that can arise from the deployment of the current applications.


DeploymentKey	The key of the desired deployment.	path	string

application/json

200 OK: Deployment details successfully retrieved.

ApplicationConflictListTextListDeployment_v2Record
403 Forbidden: User doesn't have permissions to the deployment with key <DeploymentKey>.

Exception
404 Not Found: Deployment with key <DeploymentKey> not found.

Exception
500 Internal Server Error: Failed to access the details of deployment with key <DeploymentKey>.

Exception

PUT /deployments/{DeploymentKey}/

Go to /deployments

Updates a given deployment. An optional list of applications to include in the deployment can be specified. The input is a subset of deployment object.

IssueRemoving an application from a deployment using LifeTime API effectively removes it from the deployment’s application list. RuntimeTraditional web, Reactive web, Mobile RationaleRemoving an application from a plan sets the application as "Do Nothing" while keeping it as part of the plan. Now, retrieving the deployment's information returns only the applications in the plan.

application/json

The deployment information to update.

ApplicationVersionKeyDeploymentZoneKeyRecordListTextTextTextRecord


DeploymentKey	The key of the deployment to update.	path	string

application/json

200 OK: Deployment successfully updated.

DeploymentData_v2
400 Bad Request: Invalid request.

Exception
403 Forbidden: Invalid user permissions.

Exception
404 Not Found: Deployment plan not found.

Exception
500 Internal Server Error: Failed to update deployment with key <DeploymentKey>.

Exception

GET /deployments/{DeploymentKey}/status/

Go to /deployments

Returns the details of a given deployment execution, including the deployment status and messages.


DeploymentKey	The key of the deployment whose status is being requested.	path	string

application/json

200 OK: Deployment status successfully retrieved.

DeploymentMessageListTextTextRecord
403 Forbidden: User doesn't have permissions to the deployment with key <DeploymentKey>.

Exception
404 Not Found: Deployment with key <DeploymentKey> not found.

Exception
500 Internal Server Error: Failed to retrieve the status of the deployment with key <DeploymentKey>.

Exception

POST /deployments/{DeploymentKey}/{Command}/

Go to /deployments

Executes the given command in a specified deployment. The allowed commands are “start”, “continue” and “abort”.


DeploymentKey	The key of the deployment where the command will be executed.	path	string
Command	The command to execute. One of “start”, “continue” or “abort”.	path	string
RedeployOutdated	If True, outdated applications in the target environment will be redeployed.	query	boolean
IncludeErrorDetails	If True, when an error occurs the returned message will contain more details about the error in question. This parameter is available as of LifeTime Management Console 11.21.0.	query	boolean

202 Accepted: Command <Command> executed successfully for deployment <DeploymentKey>.
400 Bad Request: Command <Command> can't be executed for deployment <DeploymentKey>.

Exception
403 Forbidden: Service Account doesn't have permissions to the deployment with key <DeploymentKey>.

Exception
404 Not Found: Deployment with key <DeploymentKey> not found, or command not found.

Exception
500 Internal Server Error: Failed to execute command <Command> for deployment with key <DeploymentKey>.

Exception

GET /environments/

Go to /environments

Lists all the environments in the infrastructure.

application/json

200 OK: Environments list successfully retrieved.

A list of Environment records.

Environment
204 No Content: No environments found.
500 Internal Server Error: Failed to list the environments.

Exception

POST /environments/

Go to /environments

Registers an environment in LifeTime. This endpoint is available as of LifeTime Management Console 11.11.0.

application/json

An EnvironmentRegistration record.

EnvironmentRegistration

application/json

201 Created: Environment registration response

TextRecord
400 Bad Request: Failed to register the environment with key because there are invalid parameters in the request.

Exception
403 Forbidden: Failed to register the environment with key because of invalid permissions.

Exception
405 Method Not Allowed: Failed to register the environment with key because the feature is not enabled.

Exception
500 Internal Server Error: Failed to register the environment with key because of an internal error.

Exception

GET /environments/{EnvironmentKey}/

Go to /environments

Returns the details of a given environment.


EnvironmentKey	The key of the desired environment.	path	string

application/json

200 OK: Environment details successfully retrieved.

Environment
403 Forbidden: Failed to retrieve the environment with key: <EnvironmentKey>. The user does not have the required permissions.

Exception
404 Not Found: Failed to retrieve the environment with key: <EnvironmentKey>.

Exception
500 Internal Server Error: Failed to access the details of environment.

Exception

DELETE /environments/{EnvironmentKey}/

Go to /environments

Unregisters an environment from LifeTime. This endpoint is available as of LifeTime Management Console 11.11.0.


EnvironmentKey	The key of the environment to unregister.	path	string

text/plain

204: Environment deleted with success.
404 Not Found: Failed to unregister the environment with key because because it was not found.

Exception
405 Method Not Allowed: Failed to unregister the environment with key because the feature is not enabled.

Exception
500 Internal Server Error: Failed to unregister environment from LifeTime.

Exception

GET /environments/{EnvironmentKey}/applications/

Go to /environments

Returns information about the running versions of all applications in a given environment.


EnvironmentKey	The key of the environment whose list of running applications is being requested.	path	string
IncludeModules	When set to true, the modules details are also retrieved. The default value is false.	query	boolean
IncludeEnvStatus	When set to true, the applications’ status information in the environment is included in the result. The default value is false.	query	boolean

application/json

200 OK: Applications list for the given environment successfully retrieved.

A list of Application records.

Application
204 No Content: No applications found in environment with key <EnvironmentKey>.
400 Bad Request: Failed to retrieve applications published in environment because IncludeModules and IncludeEnvStatus parameters were incorrect, or Invalid request when getting running applications for environment with key <EnvironmentKey>.

Exception
403 Forbidden: Failed to retrieve the running applications for environment with key <EnvironmentKey> because user has insufficient permissions.

Exception
404 Not Found: Failed to retrieve running applications for environment with key <EnvironmentKey> because it was not found.

Exception

POST /environments/{EnvironmentKey}/applications/

Go to /environments

Creates a new application in the environment. This endpoint is available as of LifeTime Management Console 11.5.0.

A structure holding the name, description and other attributes of the new application.

NewApplication


EnvironmentKey	The key of the environment to create the application.	path	string

application/json

201 Created: The key of the newly created application.

TextRecord2
400 Bad Request: Failed to create application due to invalid application name, runtime kind, template, color or team.

Exception
403 Forbidden: Failed to create an application because user has insufficient permissions.

Exception
404 Not Found: Failed to create an application for environment with key <EnvironmentKey> because it was not found.

Exception
500 Internal Server Error: Failed to create application due to an internal error.

Exception

GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/

Go to /environments

Returns information about the running version of the specified application in a given environment.


EnvironmentKey	The key of the environment from which to get the running application details.	path	string
ApplicationKey	The key of the application whose details are being requested.	path	string
IncludeEnvStatus	When set to true, the applications’ status information in the environment is included in the result. The default value is false.	query	boolean
IncludeModules	When set to true, the modules details are also retrieved. The default value is false.	query	boolean

application/json

200 OK: Application information successfully retrieved.

Application
400 Bad Request: Request asked for Modules but not for Status.

Exception
403 Forbidden: User doesn't have permissions for the given keys (EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>).

Exception
404 Not Found: Failed to retrieve the environment with key <EnvironmentKey> or the application with key <ApplicationKey>.

Exception
500 Internal Server Error: Failed to access the running version of an application.

Exception

GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/content/

Go to /environments

Returns a link where the binary file for a given application can be downloaded. The content of the download can be the Application Package for all kinds of application or the mobile application package for mobile applications that are generated correctly. The link will expire in 60 minutes.


EnvironmentKey	The key of the environment from which to get the application binary file link.	path	string
ApplicationKey	The key of the application for which to get the binary file link.	path	string
Type	The type of binary file to return, when applicable. One of “oap”, “apk” or “ipa”.	query	string

application/json

200 OK

Binary file download link successfully retrieved.

DownloadLink


Expires	The expiration date and time of the returned link.	string (date-time)

204 No Content

No binary available for given type and keys. When using type "apk" or "ipa", the error means the application is not a mobile application or the mobile application is not generated.

Exception

400 Bad Request

The required type <Type> is invalid for given keys (EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>).

Exception

403 Forbidden

User doesn't have permissions for the given keys (EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>).

Exception

404 Not Found

Failed to retrieve the environment with key <EnvironmentKey> or the application with key <ApplicationKey>.

Exception

500 Internal Server Error

Failed to download <Type> of an application.

Exception

POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/

Go to /environments

Creates a new version of the application based on the current running application.

application/json

A structure holding the new version name for the application and for its native applications, if applicable.

ApplicationVersionCreate


EnvironmentKey	The key of the environment from which to get the application.	path	string
ApplicationKey	The key of the application for which to generate a new version.	path	string

application/json

201 Created: Application version successfully created.

TextRecord
400 Bad Request: Invalid request.

Exception
403 Forbidden: Invalid user permissions.

Exception
404 Not Found: Environment or application not found.

Exception
500 Internal Server Error: Failed to tag an application, or Failed to create a new version for application <ApplicationName>.

Exception

GET /environments/{EnvironmentKey}/deploymentzones/

Go to /environments

Returns information about the deployment zones available in a given environment.


EnvironmentKey	The key of the environment from which to get the running application details.	path	string

application/json

200 OK: Deployment zone information successfully retrieved.

A list of DeploymentZone records.

DeploymentZone_v2
400 Bad Request: Failed to access the deployment zones of environment.

Exception
403 Forbidden: Failed to retrieve the deployment zones of environment <EnvironmentName> (key: <EnvironmentKey>). Error: The user does not have the required permissions, or Feature not Licensed.

Exception
404 Not Found: Failed to retrieve the deployment zones of environment with key: <EnvironmentKey>.

Exception
500 Internal Server Error: Failed to access the deployment zones of environment.

Exception

GET /environments/{EnvironmentKey}/templates/

Go to /environments

Returns information about the templates available in a given environment. This endpoint is available as of LifeTime Management Console 11.5.0.


EnvironmentKey	The key of the environment from which to get the running application details.	path	string

application/json

200 OK: Templates list successfully retrieved.

A list of Template records.

Template
400 Bad Request: Environment doesn't support list templates.

Exception
403 Forbidden: User doesn't have permissions.

Exception
404 Not Found: Environment not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /environments/{EnvironmentKey}/content_security_policies/

Go to /environments

Returns information about the Content Security Policy in a given environment. This endpoint is available as of LifeTime Management Console 11.10.3.


EnvironmentKey	The key of the environment from which to get the running Content Security Policy.	path	string

application/json

200 OK: Content Security Policy successfully retrieved.

CSPDirectives
400 Bad Request: Failed to retrieve the Content Security Policy.

Exception
403 Forbidden: User doesn't have permissions.

Exception
404 Not Found: Environment not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

PUT /environments/{EnvironmentKey}/content_security_policies/

Go to /environments

Sets the Content Security Policy for a given environment. This endpoint is available as of LifeTime Management Console 11.10.3.

application/json

The Content Security Policy directives to set in the environment.

CSPDirectives


EnvironmentKey	The key of the environment to apply the Content Security Policy.	path	string

application/json

200 OK: Content Security Policy successfully set.

Environment_CSP_Response
400 Bad Request: Failed to set Content Security Policy.

Exception
403 Forbidden: User doesn't have permissions.

Exception
404 Not Found: Environment not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /environments/{EnvironmentKey}/dbconnections/

Go to /environments

Returns all the DB connections of a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.


EnvironmentKey	The key of the environment.	path	string

application/json

200 OK: The list of DB conenctions for an environment.

A list of DBConnection_Response records.

DBConnection_Response
400 Bad Request: Failed to retrieve DB Connections due to missing parameters.

Exception
404 Not Found: Failed to retrieve DB Connections due to invalid environment key.

Exception
500 Internal Server Error: Failed to retrieve DB Connections due to internal error.

Exception

POST /environments/{EnvironmentKey}/dbconnections/

Go to /environments

Creates a new DB connection for an environment. This endpoint is available as of LifeTime Management Console 11.13.0.

application/json

A structure holding the data for the DB connection.

DBConnection_Request_POST


EnvironmentKey	The key of the environment.	path	string

application/json

201 Created: DB connection creation response.

DBConnection_Response
400 Bad Request: Failed to create DBConnections due to missing parameters.

Exception
404 Not Found: Failed to create DBConnections due to invalid environment key.

Exception
500 Internal Server Error: Failed to create DBConnections due to internal error.

Exception

GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/

Go to /environments

Returns the details of a DB Connection for a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string

application/json

200 OK: DB connection for an environment.

DBConnection_Response
400 Bad Request: Failed to retrieve DBConnection due to missing parameters.

Exception
404 Not Found: Failed to retrieve DBConnection due to invalid environment key.

Exception
500 Internal Server Error: Failed to retrieve DBConnection due to internal error.

Exception

PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/

Go to /environments

Updates a DB connection for an environment. This endpoint is available as of LifeTime Management Console 11.13.0.

application/json

A structure holding the data for the DB connection.

DBConnection_Request_POST


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string

application/json

200 OK: DB connection updated successfully.
400 Bad Request: Failed to update DBConnection due to missing parameters.

Exception
404 Not Found: Failed to update DBConnection due to invalid environment key.

Exception
500 Internal Server Error: Failed to update DBConnection due to internal error.

Exception

DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/

Go to /environments

Deletes a DB connection for an environment. This endpoint is available as of LifeTime Management Console 11.13.0.


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string

204 No Content: DBConnection deleted successfully.
400 Bad Request: Failed to delete DBConnection due to missing parameters.

Exception
404 Not Found: Failed to delete DBConnection due to invalid environment key.

Exception
500 Internal Server Error: Failed to delete DBConnection due to internal error.

Exception

PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/

Go to /environments

Sets the DB connection permission levels for a Role in a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.

application/json

The value of the permission level: Full Control, No Access, Read-Only

DBConnection_RolePermissionLevel


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string

application/json

200 OK: Permission level successfully set.
400 Bad Request: Failed to update the permission level due to missing parameters.

Exception
404 Not Found: Failed to update the permission level due to invalid environment key.

Exception
500 Internal Server Error: Failed to update the permission level due to internal error.

Exception

DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/

Go to /environments

Revokes the DB connection permissions for a Role in an environment. This endpoint is available as of LifeTime Management Console 11.13.0.

application/json

The name of the role.

DBConnectionRole


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string

200 OK: Permission level revoked successfully.
400 Bad Request: Failed to revoke the permission level due to missing parameters.

Exception
404 Not Found: Failed to revoke the permission level due to invalid environment key.

Exception
500 Internal Server Error: Failed to revoke the permission level due to internal error.

Exception

GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/{Role}/

Go to /environments

Returns the DB connection permission level of a Role for a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string
Role	The name of the role for which the permission levels will be checked.	path	string

application/json

200 OK: The permission level for a role.

DbConnectionPermissionLevel
400 Bad Request: Failed to retrieve permission level due to missing parameters.

Exception
404 Not Found: Failed to retrieve permission level due to invalid environment key.

Exception
500 Internal Server Error: Failed to retrieve permission level due to internal error.

Exception

PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/

Go to /environments

Sets the DB connection permission levels for a User in a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.

application/json

The value of the permission level: Full Control, No Access, Read-Only

DBConnection_UserPermissionLevel


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string

application/json

200 OK: Permission level successfully set.
400 Bad Request: Failed to update the permission level due to missing parameters.

Exception
404 Not Found: Failed to update the permission level due to invalid environment key.

Exception
500 Internal Server Error: Failed to update the permission level due to internal error.

Exception

DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/

Go to /environments

Revokes the DB connection permissions for a User in an environment. This endpoint is available as of LifeTime Management Console 11.13.0.

application/json

The username of the user.

DBConnectionUser


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string

200 OK: Permission level revoked successfully.
400 Bad Request: Failed to revoke the permission level due to missing parameters.

Exception
404 Not Found: Failed to revoke the permission level due to invalid environment key.

Exception
500 Internal Server Error: Failed to revoke the permission level due to internal error.

Exception

GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/{Username}/

Go to /environments

Returns the DB connection permission level of a User for a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.


EnvironmentKey	The key of the environment.	path	string
DbConnectionName	The name of the DB connection.	path	string
Username	The username of the user for whom the permission levels will be checked.	path	string

application/json

200 OK: The permission level for a user.

DbConnectionPermissionLevel
400 Bad Request: Failed to retrieve permission level due to missing parameters.

Exception
404 Not Found: Failed to retrieve permission level due to invalid environment key.

Exception
500 Internal Server Error: Failed to retrieve permission level due to internal error.

Exception

GET /environments/{EnvironmentKey}/dbconnection/dbproviders/

Go to /environments

Returns the list of providers for all the DB connections in a given environment. This endpoint is available as of LifeTime Management Console 11.13.0.


EnvironmentKey	The key of the environment.	path	string

application/json

200 OK: The list of providers for the environment's DB connections.

A list of DbProvider records.

DbProvider
400 Bad Request: Failed to retrieve the providers due to missing parameters.

Exception
404 Not Found: Failed to retrieve the providers due to invalid environment key.

Exception
500 Internal Server Error: Failed to retrieve the providers due to internal error.

Exception

GET /environments/dbconnection/permissionlevels/

Go to /environments

Returns the permission levels for the DB connections.

application/json

200 OK: The list of permission levels for the DB connection.

A list of DbConnectionPermissionLevel records.

DbConnectionPermissionLevel
500 Internal Server Error: Failed to retrieve permission levels due to internal error.

Exception

POST /environments/{EnvironmentKey}/testdbconnection/

Go to /environments

Tests the DB connection. This endpoint is available as of LifeTime Management Console 11.13.0.

application/json

A structure holding the data for the DB connection.

DBConnection_Request_POST


EnvironmentKey	The key of the environment.	path	string

application/json

200 OK: DB connection tested successfully.

DBConnection_Response
400 Bad Request: Failed to test DB Connection due to missing parameters.

Exception
404 Not Found: Failed to test DB Connection due to invalid environment key.

Exception
500 Internal Server Error: Failed to test DB Connection due to internal error.

Exception

GET /environments/blockedipaddresses/

Go to /environments

Gets the IP Addresses blocked login attempts.


EnvironmentKey	Key for the environment to unblock, if empty all environments are unblocked.	query	string

application/json

200 OK: A list of login attempts for an IP address.

A list of PlatformLoginAttempt records.

PlatformLoginAttempt
403 Forbidden: Failed to retrieve login attempts.

Exception
404 Not Found: Failed to retrieve login attempts due to invalid environment key.

Exception
500 Internal Server Error: Failed to retrieve login attempts due to internal error.

Exception
501 Not Supported: Feature not supported.

Exception

DELETE /environments/blockedipaddresses/{IPAddress}/

Go to /environments

Unblocks a given IP Address. This endpoint is available as of LifeTime Management Console 11.13.0.


IPAddress	IP Address to be unblocked.	path	string
EnvironmentKey	Key for the environment to unblock, if empty all environments are unblocked.	query	string

200 OK: IP Address unblocked successfully.
403 Forbidden: Failed to delete login attempts.

Exception
404 Not Found: Failed to delete login attempts due to invalid environment key.

Exception
500 Internal Server Error: Failed to delete login attempts due to internal error.

Exception
501 Not Supported: Feature not supported.

Exception

GET /modules/

Go to /modules

Returns a list of modules that exist in the infrastructure.


IncludeEnvStatus	When set to true, the module status per environment is also returned. The default value is false.	query	boolean

application/json

200 OK: Modules list successfully retrieved.

A list of Module records.

Module
204 No Content: No modules found in the infrastructure.
500 Internal Server Error: Failed to list modules.

Exception

GET /modules/{ModuleKey}/

Go to /modules

Returns the details of a given module.


ModuleKey	Key of the module to list the details from.	path	string
IncludeEnvStatus	Boolean to indicate if status per env should be returned. Default is false	query	boolean

application/json

200 OK: Module details successfully retrieved.

Module
403 Forbidden: Failed to retrieve the module with key: <ModuleKey>. The user does not have the required permissions.

Exception
404 Not Found: Failed to retrieve the module with key: <ModuleKey>.

Exception
500 Internal Server Error: Failed to retrieve the module with key <ModuleKey>

Exception

GET /modules/{ModuleKey}/versions/

Go to /modules

Returns a list of versions of a given module.


ModuleKey	The module from where to retrieve the versions from.	path	string
MaximumVersionsToReturn	Maximum number of versions to return. Default is 5.	query	integer (int32)

application/json

200 OK: List of module versions successfully retrieved.

A list of ModuleVersion records.

ModuleVersion_v2
400 Bad Request: Invalid request due to invalid max versions to return (less than 0).

Exception
403 Forbidden: Failed to retrieve the module with key: <ModuleKey>. The user does not have the required permissions.

Exception
404 Not Found: Failed to retrieve the module with key: <ModuleKey>.

Exception
500 Internal Server Error: Failed to list module versions.

Exception

GET /modules/{ModuleKey}/versions/{ModuleVersionKey}/

Go to /modules

Returns the details of a given module version.


ModuleKey	The module from where to retrieve the versions from.	path	string
ModuleVersionKey	Key of the module version to return.	path	string

application/json

200 OK: Module version details successfully retrieved.

ModuleVersion_v2
403 Forbidden: Failed to retrieve the module with key: <ModuleKey>. The user does not have the required permissions.

Exception
404 Not Found: Failed to retrieve the module with key: <ModuleKey>, or Failed to retrieve the module version with key: <ModuleKey>

Exception
500 Internal Server Error: Failed to access the details of a module version.

Exception

GET /roles/

Go to /roles

Lists all the roles.


IncludeEnvPermissions	Defines if it is to include a list of environment permissions for each role.	query	boolean

application/json

200 OK: List of Roles

Role
403 Forbidden: User has no permissions to retrieve roles list.

Exception
500 Internal Server Error: Internal error raised.

Exception

POST /roles/

Go to /roles

Creates a role with the specified permissions.

application/json

The role to be created.

Role

text/plain

201 Created: Role created with success.

The key of the newly created role.
400 Bad Request: Failed to create role because invalid role name, role is protected, wrong combination of infrastructure and manage teams flags or not defined/wrong permissions for all environments.

Exception
403 Forbidden: No permissions to create a new role.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /roles/permissionlevels/

Go to /roles

Gets available permission levels.

application/json

200 OK: List of permission levels.

PermissionLevels
403 Forbidden: No permissions to manage users and roles.

Exception
500 Internal Server Error: Internal error.

Exception

DELETE /roles/{RoleKey}/

Go to /roles

Deletes a role.


RoleKey	Role key to delete.	path	string
UsersNewRoleKey	Indicates the role that should replace the deleted role, for the users that have this role assigned (both as defaullt, application and team role). Needed if there are users with the role assigned.	query	boolean

204 No Content: Role deleted with success.
400 Bad Request: Role can't be deleted because it is reserved.

Exception
403 Forbidden: No permissions to delete the role.

Exception
404 Not Found: Role not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /roles/{RoleKey}/

Go to /roles

Returns the details of a given role.


RoleKey	Role key to retrieve.	path	string
IncludeEnvPermissions	Defines if it is to include a list of environment permissions for role.	query	boolean

application/json

200 OK: Record of Role

Role
403 Forbidden: User doesn't have permissions.

Exception
404 Not Found: Role not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

PUT /roles/{RoleKey}/

Go to /roles

Updates a role with the specified permissions.

application/json

The role to be update.

Role


RoleKey	Role key to update.	path	string

text/plain

200 OK: Role updated with success.

The key of the updated role.
400 Bad Request: Failed to update role because invalid role name, role is protected, wrong combination of infrastructure and manage teams flags or not defined/wrong permissions for all environments.

Exception
403 Forbidden: No permissions to update the role.

Exception
404 Not Found: Role not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /teams/

Go to /teams

Lists all the teams.


IncludeUsers	Defines if it is to include a list of users that belong to the team.	query	boolean
IncludeApplications	Defines if it is to include a list of applications that belong to the team.	query	boolean

application/json

200 OK: List of teams successfully retrieved.

A list of Team records including Users and Applications sub-lists, if requested.

Team
204 No Content: No teams defined
403 Forbidden: User has no permissions to retrieve teams list.

Exception
500 Internal Server Error: Internal error raised.

Exception

POST /teams/

Go to /teams

Creates a team with the specified details. The operation only creates the team. Users and Applications should be associated using specific endpoints.

The team to be created.

Team

201 Created: Team created with success.

Team
400 Bad Request: Failed to create team due to invalid team name.

Exception
403 Forbidden: No permissions to create a new team.

Exception
500 Internal Server Error: Internal error raised.

Exception

DELETE /teams/{TeamKey}/

Go to /teams

Deletes a team.


TeamKey	Team key to delete.	path	string

204 No Content: Team deleted with success.
403 Forbidden: No permissions to delete a team.

Exception
404 Not Found: Team not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /teams/{TeamKey}/

Go to /teams

Returns the details of a given team.


TeamKey	Team key to retrieve.	path	string
IncludeUsers	Defines if it is to include a list of users that belong to the team.	query	boolean
IncludeApplications	Defines if it is to include a list of applications that belong to the team.	query	boolean

200 OK: Record of Team

Team
403 Forbidden: User doesn't have permissions.

Exception
404 Not Found: Team not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

PUT /teams/{TeamKey}/

Go to /teams

Updates a team with the specified details. The operation only affects the Team details. Users and Applications should be associated or dissociated using specific endpoints.

The team to be updated.

Team


TeamKey	Team key to update.	path	string

200 OK: Team updated with success.

Team
400 Bad Request: Failed to update team due to invalid team name.

Exception
403 Forbidden: No permissions to update the team.

Exception
404 Not Found: Team not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

POST /teams/{TeamKey}/applications/

Go to /teams

Adds the specified application to a given team. The operation adds an existing application to the team. To create a new application, use POST /environments/{EnvironmentKey}/applications/

The application information to be added.

ApplicationShortInfo


TeamKey	The key of the team where the add the applications.	path	string

201 Created: Application added with success.
400 Bad Request: Failed to add application to team because application doesn't exist.

Exception
403 Forbidden: No permissions to update the team.

Exception
404 Not Found: Team not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

DELETE /teams/{TeamKey}/applications/{ApplicationKey}

Go to /teams

Removes application from the given team.


TeamKey	The team unique identifier.	path	string
ApplicationKey	The application unique identifier.	path	string

200 OK: Application removed with success.
400 Bad Request: Failed to remove application to team because application doesn't exist.

Exception
403 Forbidden: No permissions to update the team.

Exception
404 Not Found: Team or application not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

POST /teams/{TeamKey}/users/

Go to /teams

Adds a user to a team with a specified role.

The user and role information to be added.

UserRoleShortInfo


TeamKey	The key of the team where the add the user.	path	string

201 Created: User added with success.
400 Bad Request: Failed to add user to team because user doesn't exist or role doesn't exist.

Exception
403 Forbidden: No permissions to update the team.

Exception
404 Not Found: Team not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

DELETE /teams/{TeamKey}/users/{UserKey}/

Go to /teams

Removes a user from the given team


TeamKey	The key of the team where the remove the user.	path	string
UserKey	The key of the user to be removed.	path	string

200 OK: User removed with success.
400 Bad Request: Failed to remove user from team because user doesn't exist or role doesn't exist.

Exception
403 Forbidden: No permissions to update the team.

Exception
404 Not Found: Team or user not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /users/

Go to /users

Lists all the users. By default shows only active users.


IncludeInactive	Defines if it is to include a list of inactive users.	query	boolean
IncludeTeams	Defines if it is to include a list of teams that the users belong to.	query	boolean
IncludeApplicationRoles	Defines if it is to include a list of applications that the users are associated with.	query	boolean

application/json

200 OK: List of users successfully retrieved.

A list of User records.

User
204 No Content: No Users defined
403 Forbidden: User has no permissions to retrieve users list.

Exception
500 Internal Server Error: Internal error raised.

Exception

POST /users/

Go to /users

Creates a user with the specified details. The operation only creates the user. Teams and Applications should be associated using specific endpoints.

The user to be created.

User

201 Created: User created with success.

The key of the newly created user.
400 Bad Request: Failed to create user due to invalid username, name or role.

Exception
403 Forbidden: No permissions to create a new user.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /users/{UserKey}/

Go to /users

Returns the details of a given user.


UserKey	User key to retrieve.	path	string
includeTeams	Defines if it is to include a list of teams that the user belong to.	query	boolean
includeApplicationRoles	Defines if it is to include a list of applications that the user is associated with.	query	boolean

application/json

200 OK: Record of User

User
403 Forbidden: User doesn't have permissions.

Exception
404 Not Found: User not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

PUT /users/{UserKey}/

Go to /users

Updates a user with the specified details. The operation only updates the user details. Teams and Applications should be associated using specific endpoints.

application/json

The user to be updated.

User


UserKey	User key to update.	path	string

text/plain

200 OK: User updated with success.

The key of the updated user.
400 Bad Request: Failed to update user due to invalid username, name or role.

Exception
403 Forbidden: No permissions to update the user.

Exception
404 Not Found: User not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

POST /users/{UserKey}/applications/

Go to /users

Grants a given role to the given application to the user.

application/json

The key of the application and Role to grant permissions.

ApplicationRole


UserKey	User key to grant permissions.	path	string

text/plain

201 Created: Permissions granted with success.
400 Bad Request: Failed to add application to user because application or role are invalid.

Exception
403 Forbidden: No permissions to change User permissions.

Exception
404 Not Found: User not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

DELETE /users/{UserKey}/applications/{ApplicationKey}/

Go to /users

Revokes user's role in application permission.

application/json


UserKey	User key to grant permissions.	path	string
ApplicationKey	The key of the application to grant permissions.	path	string

text/plain

204 No Content: Permissions revoked with success.
403 Forbidden: No permissions to change User permissions.

Exception
404 Not Found: User or permission not found.

Exception
500 Internal Server Error: Internal error raised.

Exception

POST /users/{UserKey}/setpassword/

Go to /users

Allows to change a password of a given user.

application/json

The new password value.

Password

Passwords must meet the password complexity rules. This means that the password must have at least 12 characters, including at least one number, one lowercase letter, and one uppercase letter.


UserKey	User key to update.	path	string

text/plain

200 OK: User password updated with success.
400 Bad Request: Failed to change password because the password is invalid.

Exception
403 Forbidden: No permissions to update the user password.

Exception
404 Not Found: User not found.

Exception
405 Method Not Allowed: Failed to change password because external authentication provider is in use.

Exception
500 Internal Server Error: Internal error raised.

Exception

GET /users/{UserKey}/blockedlogins/

Go to /users

Gets the users blocked login attempts.


UserKey	The key of the User to retrieve.	path	string
EnvironmentKey	Key for the environment to check, if empty all environments are returned.	query	string

application/json

200 OK: Blocked login attempts retrieved successfully.

A list of PlatformLoginAttempt records.

PlatformLoginAttempt
403 Forbidden: Failed to retrieve login attempts.

Exception
404 Not Found: Failed to retrieve login attempts due to invalid environment key.

Exception
500 Internal Server Error: Failed to retrieve login attempts due to internal error.

Exception
501 Not Supported: Feature not supported.

Exception

DELETE /users/{UserKey}/blockedlogins/

Go to /users

Unblocks a given user.


UserKey	The key of the User to unblock.	path	string
EnvironmentKey	Key for the environment to unblock, if empty all environments are unblocked.	query	string
IpAddress	IP Address to unblock the user. All if no IP is passed.	query	string

application/json

200 OK: User unblocked successfully.
403 Forbidden: Failed to delete login attempts.

Exception
404 Not Found: Failed to delete login attempts due to invalid environment key.

Exception
500 Internal Server Error: Failed to delete login attempts due to internal error.

Exception
501 Not Supported: Feature not supported.

Exception

Structures

Application: object

An application with its details and its status in the environments were it is running.

Key: string: Application unique identifier.
Name: string: Name of the application.
Kind: string: Identifies the kind of application. [Mobile|WebResponsive]
Team: string: The team that owns the application.
Description: string: Description of the application.
URLPath: string: Relative URL path of the application, starting from the hostname.
IconHash: string: Hash of the application icon. Can be used to detect changes in the application icon.
IconURL: string: The URL for the application icon.
IsSystem: boolean: Indicates if the application is a built-in component of the AgilePlatform (e.g. ServiceCenter, LifeTime, ...).
AppStatusInEnvs: object[]: Information about the status of the application in each environment it is running.

AppStatusInEnv_v2

ApplicationConflict: object

A depoyment conflict.

Message: string: Description of the conflict.
ProducerApplicationOperation: ApplicationOperation
ConsumerApplicationOperation: ApplicationOperation
ModuleConflict: ModuleConflict

ApplicationConflictListTextListDeployment_v2Record: object

Deployment: Deployment_v2
ApplicationsToRedeploy: string[]: string
ApplicationConflicts: object[]: ApplicationConflict

ApplicationOperation: object

Operation executed in the deployment over the application.

ApplicationKey: string: Application unique identifier.
ApplicationVersionKey: string: Application Version unique identifier.
DeploymentOperation: string: Label of the operation to be performed. Example: Deploy 1.5.

ApplicationOperation_v2: object

Operation executed in the deployment over the application.

ApplicationKey: string: Application unique identifier.
ApplicationVersionKey: string: Application Version unique identifier.
DeploymentOperation: string: Label of the operation to be performed. Example: Deploy 1.5.
DeploymentZoneKey: string: Deployment Zone unique identifier

ApplicationRole: object

Represents a set of an application and a role.

applicationKey: string
applicationName: string
roleKey: string
roleName: string

ApplicationShortInfo: object

A simplification of application structure.

Key: string: Application unique identifier.
Name: string: Name of the application.

ApplicationVersion_v2: object

Information about a specific version of an application and the versions of its modules.

Key: string: Application version unique identifier.
ApplicationKey: string: Application unique identifier.
Version: string: Version of the application.
ChangeLog: string: Change Log associated to this Application Version.
CreatedOn: string (date-time): When was the Application Version created.

"2014-12-31T23:59:59.938Z"
InUse: boolean: Defines if the Application Version is being used.
MobileVersions: object[]: List of mobile versions.

MobileVersion
PrimaryColor: string: The primary color of the application interface.
NativeHash: string: The native has relative to the mobile platform.
ModuleVersions: object[]: List of module versions.

ModuleVersion_v2

ApplicationVersionCreate: object

A structure holding the new version name for the application and for its native applications, if applicable.

ChangeLog: string: Change log of the version to be created.
Version: string: Version of the application.
MobileVersions: object[]: List of mobile versions.

MobileVersion
ModuleVersionKeys: string[]: [DEPRECATED] List of module version keys to validate if the current state of the application is still the expected. This parameter was deprecated on LifeTime Feb 2019 Release, there is no need to pass the module version keys. If the module version keys are passed, they will still be validated.

string

ApplicationVersionKeyDeploymentZoneKeyRecordListTextTextTextRecord: object

Notes: string
SourceEnvironmentKey: string
TargetEnvironmentKey: string
ApplicationOperations: object[]: TextTextRecord

AppStatusInEnv_v2: object

Status of application in a given environment.

EnvironmentKey: string: Environment unique identifier.
BaseApplicationVersionKey: string: Base application version unique identifier. If app is not modified in environment, this is the application version deployed.
IsModified: boolean: True if the application has been changed since the last tag, false otherwise.
IsModifiedReason: string: Indicates the application status.
IsModifiedMessage: string: Indicates the application status.
ConsistencyStatus: string: Indicates the application consistency status.
ConsistencyStatusMessages: string: Messages regarding the consistency status of the application.
MobileAppsStatus: object[]: Status of mobile apps in environment.

MobileAppStatusInEnv
ModuleStatusInEnvs: object[]: Status of modules in environment.

ModuleStatusInEnv
DeploymentZoneKey: string: Deployment Zone unique identifier

Deployment_v2: object

Deployment information with the operations executed.

Key: string: Deployment unique identifier.
SourceEnvironmentKey: string: Source environment unique identifier.
TargetEnvironmentKey: string: Target environment unique identifier.
Notes: string: Deployment notes.
CreatedOn: string (date-time): Date and time when the deployment plan was created.

"2014-12-31T23:59:59.938Z"
CreatedBy: string: Name of the user who created the deployment plan.
CreatedByUsername: string: Username of the user who created the deployment plan.
SavedOn: string (date-time): The date and time when the deployment plan was saved.

"2014-12-31T23:59:59.938Z"
SavedBy: string: Name of the user who last saved the deployment plan.
SavedByUsername: string: Username of the user who last saved the deployment plan.
StartedOn: string (date-time): The date and time when the deployment started.

"2014-12-31T23:59:59.938Z"
StartedBy: string: Name of the user who started the deployment.
StartedByUsername: string: Username of the user who started the deployment.
AbortedOn: string (date-time): The date and time when the deployment was aborted.

"2014-12-31T23:59:59.938Z"
AbortedBy: string: Name of the user who aborted the deployment.
AbortedByUsername: string: Username of the user who aborted the deployment.
ApplicationOperations: object[]: List of Application Operations included in the deployment.

ApplicationOperation_v2

DeploymentData_v2: object

Deployment information with the operations executed.

Key: string: Deployment unique identifier.
SourceEnvironmentKey: string: Source environment unique identifier.
TargetEnvironmentKey: string: Target environment unique identifier.
Notes: string: Deployment notes.
CreatedOn: string (date-time): Date and time when the deployment plan was created.

"2014-12-31T23:59:59.938Z"
CreatedBy: string: Name of the user who created the deployment plan.
CreatedByUsername: string: Username of the user who created the deployment plan.
SavedOn: string (date-time): The date and time when the deployment plan was saved.

"2014-12-31T23:59:59.938Z"
SavedBy: string: Name of the user who last saved the deployment plan.
SavedByUsername: string: Username of the user who last saved the deployment plan.
StartedOn: string (date-time): The date and time when the deployment started.

"2014-12-31T23:59:59.938Z"
StartedBy: string: Name of the user who started the deployment.
StartedByUsername: string: Username of the user who started the deployment.
AbortedOn: string (date-time): The date and time when the deployment was aborted.

"2014-12-31T23:59:59.938Z"
AbortedBy: string: Name of the user who aborted the deployment.
AbortedByUsername: string: Username of the user who aborted the deployment.
ApplicationOperations: object[]: List of Application Operations included in the deployment.

TextTextRecord

DeploymentMessage: object

Message from a deployment operation log.

Instant: string (date-time): Date and time when the message was logged.

"2014-12-31T23:59:59.938Z"
Message: string: Details of the message.

DeploymentMessageListTextTextRecord: object

DeploymentStatus: string
Info: string
DeploymentLog: object[]: DeploymentMessage

DeploymentTechnology_v2: object

Deployment Hosting technology of the Deployment Zone.

Key: string: Deployment Technology unique identifier.
Name: string: Name of deployment technology

DeploymentZone_v2: object

Deployment Zone of an environment.

Key: string: Deployment Zone unique identifier.
Name: string: Name of deployment zone
IsDefault: boolean: True if the deployment zone is the default one in the environment
DeploymentTechnology: DeploymentTechnology_v2

DownloadLink: object

The link for the application binary file.

url: string: The link for the application binary file.
expires: string (date-time): The expiration date and time of the returned link.

"2014-12-31T23:59:59.938Z"

Environment: object

An environment and its information.

Key: string: Unique identifier of the environment.
Name: string: Name of the environment.
OSVersion: string: Platform Server version. [X.X.X.X]
Order: integer (int32): The order of the environment as registered in Lifetime.
HostName: string: Hostname of the environment as registered.
UseHTTPS: boolean: Indicates if connections to the environment are made using HTTPS.
EnvironmentType: string: Indicates the type of the environment. [Development | Test | Production]
NumberOfFrontEnds: integer (int32): Number of front-end servers in the environment.
ApplicationServerType: string: Stack of the application server. [.NET | JAVA]
ApplicationServer: string: Application server in use. [IIS | JBoss | WebLogic]
DatabaseProvider: string: Type of database provider. [SqlServer | Oracle]
IsCloudEnvironment: boolean: Indicates if the environment is running on a cloud service.

EnvironmentPermission: object

Definition of Environment Permissions

environmentKey: string: Key of the environment that refers to the permission.
environmentName: string: Name of the environment that refers to the permission.
level: integer: Level of permission.
levelLabel: string: Short description of the permission level.
createApplications: boolean: Allows to create new applications.
addDependenciesToSystem: boolean: Allows to add depedencies to System application.

Exception: object

Errors: string[]: string

Full detail of the error
StatusCode: integer 500: Status code raised with the error.

MobileAppStatusInEnv: object

Status of mobile application in a given environment.

EnvironmentKey: string: Environment unique identifier.
NativePlatform: string: Name of native platform. [Android | iOS]
VersionNumber: string: The version number, like for example 1.5.4, of the native build. It is used to be able to map the version to the version in the Andoid or iOS store.
HasBinaryAvailable: boolean: True if the binary of the application is available for the current configuration.
IsConfigured: boolean: True if the application is configured.
IsConfigurationChanged: boolean: True if the configuration of the Mobile Application has changed in the environment.
IsModified: boolean: True if the Native Hash of the Mobile Application does not match the one in the AppVersionNativeBuild baseline.

MobileVersion: object

A mobile version and its information.

NativePlatform: string: Name of native platform. [Android | iOS]
VersionNumber: string: The version number, like for example 1.5.4, of the native build. It is used to be able to map the version to the version in the Andoid or iOS store.
VersionDescription: string: The description of the mobile version.

Module: object

Module information and the status in the environments where the modules are running.

Key: string: Module unique identifier.
Name: string: Name of the module.
Description: string: Description of the module.
Kind: string: Module type (eSpace or Extension).
ModuleStatusInEnv: object[]: Status of the module in environments

ModuleStatusInEnv

ModuleConflict: object

A module conflict.

ProducerModuleKey: string: Producer Module unique identifier.
ConsumerModuleKey: string: Consumer Module unique identifier.
TotalRequiredElements: integer (int32): Total number of required elements.
ConflictType: string: Type of conflict. [Producer Module Missing|Producer Element Missing|Producer Element Incompatible|Consumer Module Outdated|Newer Producer Module Available|IncompatiblePlatformServer|ConsumerModuleMoved|ProducerModuleMoved|NameColision]

ModuleStatusInEnv: object

Status of module in a given environment.

ApplicationKey: string: Application unique identifier.
EnvironmentKey: string: Environment unique identifier.
ModuleVersionKey: string: Module version unique identifier.
ConsistencyStatus: string: Indicates the module consistency status.
ConsistencyStatusMessages: string: Messages regarding the consistency status of the module.

ModuleVersion_v2: object

A module version and its information.

Key: string: Module version unique identifier.
ModuleKey: string: Module unique identifier.
CreatedOn: string (date-time): Date and time of the module version creation.

"2014-12-31T23:59:59.938Z"
CreatedBy: string: Name of the user that created the version.
CreatedByUsername: string: Username of the user that created the version.
GeneralHash: string: Non-unique hash of the module version. Can be used to validate if two module versions have semantic differences.
DirectUpgradeFromHash: string: If this module version is the result of a direct upgrade of another version, then this field contains the key of that version

NewApplication: object

TemplateKey: string
TeamKey: string
Name: string
Description: string
Color: string

Password: object

Definition of a password.

password: string: Password value.

PermissionLevels: object

level: integer: Value that identifies the permission level.
levelLabel: string: Short description of the permission level.
description: string: Full description of the permission level.

PlatformLoginAttempt: object

userId: integer (int32)
username: string
success: boolean
instant: string (date-time)
ipAddress: string
usernameFailureCount: integer (int32)
originAddressFailureCount: integer (int32)
userAgent: string
visitor: string
requestKey: string
result: string
environmentId: integer (int32)
environmentName: string

Role: object

Full definition of a role.

key: string: Identifier of a role.
name: string: Name of a role
manageInfrastructure: boolean: Allows manage the infrastructure.
manageTeams: boolean: Allows to manage teams and roles.
environmentPermissions: object[]: Definition of permission levels per environment.

EnvironmentPermission

Team: object

Definition of a team

key: string
name: string
description: string
users: object[]: UserRole
applications: object[]: ApplicationShortInfo

TeamRole: object

Pair Team and Role information.

TeamKey: string
TeamName: string
RoleKey: string
RoleName: string

Template: object

Template of an environment.

Key: string: Template unique identifier.
Name: string: Name of template.
Description: string: Description of template.
ApplicationKind: string: Type of the application [Web|Mobile|Service|Reactive].

TextRecord: object

ApplicationVersionKey: string: The key of the newly created application version.

TextRecord2: object

ApplicationKey: string

TextTextRecord: object

ApplicationVersionKey: string
DeploymentZoneKey: string

User: object

Definition of a user. Also includes the teams to which the user belongs and the roles in specific applications.

Key: string
Username: string
Name: string
Email: string
IsActive: boolean true
RoleKey: string
RoleName: string
ApplicationRoles: object[]: ApplicationRole
Teams: object[]: TeamRole

UserRole: object

Pair User and Role information.

UserKey: string
Name: string
Username: string
RoleKey: string
RoleName: string

UserRoleShortInfo: object

Pair User Key and Role Key minimal information.

userKey: string
roleKey: string

CSPDirectives: object

The Content Security Policy directives for an environment.

BaseUri: CSPDirective
ChildSrc: CSPDirective
ConnectSrc: CSPDirective
DefaultSrc: CSPDirective
FontSrc: CSPDirective
ImgSrc: CSPDirective
MediaSrc: CSPDirective
ObjectSrc: CSPDirective
PluginTypes: CSPDirective
ScriptSrc: CSPDirective
StyleSrc: CSPDirective
FrameAncestors: CSPDirective
ReportTo: CSPDirective
Other: CSPDirective

CSPDirective: object

A directive of the Content Security Policy.

CSPDirectiveId: integer (int32)
Value: string
IsSetForEnv: boolean

Environment_CSP_Response: object

Detailed result of setting the Content Security Policy for an environment.

Success: boolean
EnvironmentKey: string
ErrorDirectives: string[]: string
ErrorMessage: string
NeedsRecompilation: boolean
AddedDataDirectivess: string[]: string
AddedSelfDirectives: string[]: string
AddedInternalDirectives: string[]: string
AddedGapDirectives: string[]: string

EnvironmentRegistration: object

Environment information needed for the registration process.

EnvironmentName: string: Name that identifies the environment in LifeTime.
EnvironmentAddress: string: Address that LifeTime will use to connect with the environment.
ServiceCenterUsername: string: Username of a Service Center user with administrator privileges.
ServiceCenterPassword: string: Password of the Service Center user with administrator privileges.
LifeTimeAddress: string: Address that the environment will use to communicate with LifeTime.
EnvironmentPosition: integer (int32): The staging position order of the environment in Lifetime.
OverridePreviousLifetime: boolean: If true, the environment registration will override the previous LifeTime of the environment (when the environment is already registered in another LifeTime).
EnvironmentRolePermissions: object[]: List of roles and permissions.

EnviromentRolePermissions

EnviromentRolePermissions: object

Pair of Role and permissions.

RoleKey: string: Role Key.
PermissionLevel: integer (int32): Permission Level.
CanCreateApplications: boolean: True, if the role allows to create applications.
CanAddDependenciesToSystem: boolean: True, if the role allows to add dependencies to system.

EnvironmentRegistration_Users: object

List of imported users

Username: string: Username of an IT user.
Name: string: Name of an IT user.
Email: string: Email of an IT user.

TextEnvironmentRegistration_UsersListRecord: object

EnvironmentKey: string
ImportedUsers: object[]: EnvironmentRegistration_Users

DBConnection_Request_POST: object

Body of the request to create a new DB connection.

dbConnectionName: string: The name of the DB connection.
providerKey: string: The key of the provider for the DB connection.
description: string: The description of the DB connection.
dbUsername: string: The username for the DB connection.
dbPassword: string: The password for the DB connection.
dbConfigParams: string: DB connection configuration parameters. Configuration parameters must be separated by a semi-colon ';'.

DBConnection_Response: object

Body of the responde of the Get, List and Create methods for a DB Connection.

dbConnectionName: string: The name of the DB connection.
description: string: The description of the DB connection.
providerName: string: The name of the provider for the DB connection.
isAdvancedConfiguration: boolean: Boolean to define if it is an advanced configuration for the DB connection. True when the DB configuration parameters are set in the request.
databaseConfiguration: string: The DB configuration values when setting an advanced configuration.

DBConnection_RolePermissionLevel: object

Structure that holds the data to manipulate the permission level for DB connections for a role.

role: string: Role name.
permissionLevel: integer (int32): Identifier of the permission level. Permission levels: Full Control, No Access, Read-Only

DBConnection_UserPermissionLevel: object

Structure that holds the data to manipulate the permission level for DB connections for a user.

username: string: Username of the user.
permissionLevel: integer (int32): Identifier of the permission level. Permission levels: Full Control, No Access, Read-Only

DbConnectionPermissionLevel: object

Structure that holds the data to manipulate the permission level for DB connections.

Id: integer (int32): The identifier of the permission level.
Label: string: The label of the environment permission level.
ShortLabel: string: A shorter label of the permission level.
Description: string: The full description of the permission level.
Level: integer (int32): An integer representing the permission level.

DbConnectionPermissionLevelRecord: object

Structure that holds DBConnectionPermissionLevel records.

DbConnectionPermissionLevel: DbConnectionPermissionLevel

DBConnectionRole: object

Structure that describes a Role for a DBConnection.

role: string: Name of the role.

DBConnectionUser: object

Structure that describes a User for a DBConnection.

username: string: Username of the user.

DbProvider: object

Structure that describes a DB Provider.

DisplayName: string
ProviderKey: string

FilesExpand file tree

lifetime-deployment-api-v2.final.md

Latest commit

History

lifetime-deployment-api-v2.final.md

File metadata and controls

LifeTime API v2

Summary {#swagger--summary-tags}

/applications

/environments

/deployments

/modules

/roles

/teams

/users

Endpoints

GET /applications/

GET /applications/{ApplicationKey}/

GET /applications/{ApplicationKey}/versions/

DELETE /applications/{ApplicationKey}/versions/{VersionKey}/

GET /applications/{ApplicationKey}/versions/{VersionKey}/

GET /applications/{ApplicationKey}/versions/{VersionKey}/content/

GET /deployments/

POST /deployments/

DELETE /deployments/{DeploymentKey}/

GET /deployments/{DeploymentKey}/

PUT /deployments/{DeploymentKey}/

GET /deployments/{DeploymentKey}/status/

POST /deployments/{DeploymentKey}/{Command}/

GET /environments/

POST /environments/

GET /environments/{EnvironmentKey}/

DELETE /environments/{EnvironmentKey}/

GET /environments/{EnvironmentKey}/applications/

POST /environments/{EnvironmentKey}/applications/

GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/

GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/content/

POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/

GET /environments/{EnvironmentKey}/deploymentzones/

GET /environments/{EnvironmentKey}/templates/

GET /environments/{EnvironmentKey}/content_security_policies/

PUT /environments/{EnvironmentKey}/content_security_policies/

GET /environments/{EnvironmentKey}/dbconnections/

POST /environments/{EnvironmentKey}/dbconnections/

GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/

PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/

DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/

PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/

DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/

GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/rolepermissionlevel/{Role}/

PUT /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/

DELETE /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/

GET /environments/{EnvironmentKey}/dbconnections/{DbConnectionName}/userpermissionlevel/{Username}/

GET /environments/{EnvironmentKey}/dbconnection/dbproviders/

GET /environments/dbconnection/permissionlevels/

POST /environments/{EnvironmentKey}/testdbconnection/

GET /environments/blockedipaddresses/

DELETE /environments/blockedipaddresses/{IPAddress}/

GET /modules/

GET /modules/{ModuleKey}/

GET /modules/{ModuleKey}/versions/

GET /modules/{ModuleKey}/versions/{ModuleVersionKey}/

GET /roles/

POST /roles/

GET /roles/permissionlevels/

DELETE /roles/{RoleKey}/

GET /roles/{RoleKey}/

PUT /roles/{RoleKey}/

GET /teams/

POST /teams/

DELETE /teams/{TeamKey}/

GET /teams/{TeamKey}/

PUT /teams/{TeamKey}/

POST /teams/{TeamKey}/applications/

DELETE /teams/{TeamKey}/applications/{ApplicationKey}

POST /teams/{TeamKey}/users/

DELETE /teams/{TeamKey}/users/{UserKey}/

GET /users/

POST /users/

GET /users/{UserKey}/