TsuruApi

All URIs are relative to https://localhost

Method	HTTP request	Description
appBuild	POST /1.5/apps/{name}/build	Build application
appCreate	POST /1.0/apps	Create application
appDeploy	POST /1.0/apps/{name}/deploy	Deploy application
appDeployRebuild	POST /1.3/apps/{name}/deploy/rebuild	Rebuild deploy application deployment
appDeployRollback	POST /1.0/apps/{name}/deploy/rollback	Rollback application deployment
appDeployRollbackUpdate	PUT /1.0/apps/{name}/deploy/rollback/update	Rollback application deployment
appGrant	PUT /1.0/apps/{name}/teams/{team}	Grant isPublic application
appInfo	GET /1.0/apps/{name}	Application information
appList	GET /1.0/apps	Get Applications
appLog	GET /1.0/apps/{name}/log	Get application logs.
appRemove	DELETE /1.0/apps/{name}	Delete application
appRestart	POST /1.0/apps/{name}/restart	Restart application
appRevoke	DELETE /1.0/apps/{name}/teams/{team}	Revoke isPublic on application
appRun	POST /1.0/apps/{name}/run	Run command inside app container
appStart	POST /1.0/apps/{name}/start	Start application
appStop	POST /1.0/apps/{name}/stop	Stop application
appSwap	POST /1.0/swap	Swap applications
appUpdate	PUT /1.0/apps/{name}	Update application
envSet	POST /apps/{name}/env	Set env on application
envUnset	DELETE /apps/{name}/env	Set env on application
getApiKey	GET /1.0/users/api-key	Get ApiKey for user.
regenerateApiKey	POST /1.0/users/api-key	Regenerate ApiKey for user.
userList	GET /1.0/users	Get Users.

appBuild

String appBuild(name, tag, file)

Build application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String tag = "tag_example"; // String | 
File file = new File("/path/to/file.txt"); // File | 
try {
    String result = apiInstance.appBuild(name, tag, file);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appBuild");
    e.printStackTrace();
}

Parameters

Name	Type	Description
name	String	Application name.
tag	String
file	File

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

appCreate

String appCreate(name, platform, plan, teamOwner, pool, description, tag, router, routeropts)

Create application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | 
String platform = "platform_example"; // String | 
String plan = "plan_example"; // String | 
String teamOwner = "teamOwner_example"; // String | 
String pool = "pool_example"; // String | 
String description = "description_example"; // String | 
List<String> tag = Arrays.asList("tag_example"); // List<String> | 
String router = "router_example"; // String | 
List<String> routeropts = Arrays.asList("routeropts_example"); // List<String> | 
try {
    String result = apiInstance.appCreate(name, platform, plan, teamOwner, pool, description, tag, router, routeropts);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appCreate");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
name	String	[optional]
platform	String	[optional]
plan	String	[optional]
teamOwner	String	[optional]
pool	String	[optional]
description	String	[optional]
tag	List<String>	[optional]
router	String	[optional]
routeropts	List<String>	[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appDeploy

String appDeploy(name, file, image)

Deploy application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
File file = new File("/path/to/file.txt"); // File | 
String image = "image_example"; // String | 
try {
    String result = apiInstance.appDeploy(name, file, image);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appDeploy");
    e.printStackTrace();
}

Parameters

Name	Type	Description
name	String	Application name.
file	File
image	String

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

appDeployRebuild

String appDeployRebuild(name, origin)

Rebuild deploy application deployment

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String origin = "origin_example"; // String | 
try {
    String result = apiInstance.appDeployRebuild(name, origin);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appDeployRebuild");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
origin	String		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appDeployRollback

String appDeployRollback(name, origin, image)

Rollback application deployment

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String origin = "origin_example"; // String | 
String image = "image_example"; // String | 
try {
    String result = apiInstance.appDeployRollback(name, origin, image);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appDeployRollback");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
origin	String		[optional]
image	String		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appDeployRollbackUpdate

String appDeployRollbackUpdate(name, origin, reason, disable, image)

Rollback application deployment

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String origin = "origin_example"; // String | 
String reason = "reason_example"; // String | 
Boolean disable = true; // Boolean | 
String image = "image_example"; // String | 
try {
    String result = apiInstance.appDeployRollbackUpdate(name, origin, reason, disable, image);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appDeployRollbackUpdate");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
origin	String		[optional]
reason	String		[optional]
disable	Boolean		[optional]
image	String		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appGrant

String appGrant(name, team)

Grant isPublic application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String team = "team_example"; // String | Team name.
try {
    String result = apiInstance.appGrant(name, team);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appGrant");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
team	String	Team name.

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

appInfo

Application appInfo(name)

Application information

The backend endpoint returns the address that the application is published.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
try {
    Application result = apiInstance.appInfo(name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appInfo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.

Return type

Application

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

appList

List<Application> appList()

Get Applications

The backend endpoint returns the address that the application is published.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
try {
    List<Application> result = apiInstance.appList();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appList");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<Application>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

appLog

String appLog(name, lines)

Get application logs.

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | 
Integer lines = 56; // Integer | 
try {
    String result = apiInstance.appLog(name, lines);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appLog");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String
lines	Integer

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

appRemove

String appRemove(name)

Delete application

The backend endpoint deletes the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
try {
    String result = apiInstance.appRemove(name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appRemove");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

appRestart

String appRestart(name, process)

Restart application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String process = "process_example"; // String | 
try {
    String result = apiInstance.appRestart(name, process);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appRestart");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
process	String		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appRevoke

String appRevoke(name, team)

Revoke isPublic on application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String team = "team_example"; // String | Team name.
try {
    String result = apiInstance.appRevoke(name, team);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appRevoke");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
team	String	Team name.

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

appRun

String appRun(name, command, once, isolated)

Run command inside app container

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String command = "command_example"; // String | 
Boolean once = true; // Boolean | 
String isolated = "isolated_example"; // String | 
try {
    String result = apiInstance.appRun(name, command, once, isolated);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appRun");
    e.printStackTrace();
}

Parameters

Name	Type	Description
name	String	Application name.
command	String
once	Boolean
isolated	String

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appStart

String appStart(name, process)

Start application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String process = "process_example"; // String | 
try {
    String result = apiInstance.appStart(name, process);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appStart");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
process	String		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appStop

String appStop(name, process)

Stop application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String process = "process_example"; // String | 
try {
    String result = apiInstance.appStop(name, process);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appStop");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
process	String		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appSwap

String appSwap(app1, app2, force, cnameOnly)

Swap applications

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String app1 = "app1_example"; // String | 
String app2 = "app2_example"; // String | 
Boolean force = true; // Boolean | 
Boolean cnameOnly = true; // Boolean | 
try {
    String result = apiInstance.appSwap(app1, app2, force, cnameOnly);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appSwap");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
app1	String
app2	String
force	Boolean
cnameOnly	Boolean

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

appUpdate

String appUpdate(name, platform, plan, teamOwner, pool, description, tag)

Update application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | Application name.
String platform = "platform_example"; // String | 
String plan = "plan_example"; // String | 
String teamOwner = "teamOwner_example"; // String | 
String pool = "pool_example"; // String | 
String description = "description_example"; // String | 
List<String> tag = Arrays.asList("tag_example"); // List<String> | 
try {
    String result = apiInstance.appUpdate(name, platform, plan, teamOwner, pool, description, tag);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#appUpdate");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	Application name.
platform	String		[optional]
plan	String		[optional]
teamOwner	String		[optional]
pool	String		[optional]
description	String		[optional]
tag	List<String>		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

envSet

String envSet(name, envs, noRestart, _private)

Set env on application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | 
String envs = "envs_example"; // String | 
Boolean noRestart = true; // Boolean | 
Boolean _private = true; // Boolean | 
try {
    String result = apiInstance.envSet(name, envs, noRestart, _private);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#envSet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String
envs	String
noRestart	Boolean
_private	Boolean

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

envUnset

String envUnset(name, env, noRestart)

Set env on application

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String name = "name_example"; // String | 
List<String> env = Arrays.asList("env_example"); // List<String> | 
Boolean noRestart = true; // Boolean | 
try {
    String result = apiInstance.envUnset(name, env, noRestart);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#envUnset");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String
env	List<String>
noRestart	Boolean

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getApiKey

InlineResponse200 getApiKey(user)

Get ApiKey for user.

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String user = "user_example"; // String | 
try {
    InlineResponse200 result = apiInstance.getApiKey(user);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#getApiKey");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
user	String		[optional]

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

regenerateApiKey

InlineResponse200 regenerateApiKey(user)

Regenerate ApiKey for user.

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String user = "user_example"; // String | 
try {
    InlineResponse200 result = apiInstance.regenerateApiKey(user);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#regenerateApiKey");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
user	String		[optional]

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

userList

List<User> userList(userEmail, role, context)

Get Users.

The backend endpoint the backend.

Example

// Import classes:
//import io.tsuru.client.ApiException;
//import io.swagger.client.api.TsuruApi;


TsuruApi apiInstance = new TsuruApi();
String userEmail = "userEmail_example"; // String | 
String role = "role_example"; // String | 
String context = "context_example"; // String | 
try {
    List<User> result = apiInstance.userList(userEmail, role, context);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TsuruApi#userList");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
userEmail	String	[optional]
role	String	[optional]
context	String	[optional]

Return type

List<User>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

Files

TsuruApi.md

Latest commit

History

TsuruApi.md

File metadata and controls

TsuruApi

appBuild

Example

Parameters

Return type

Authorization

HTTP request headers

appCreate

Example

Parameters

Return type

Authorization

HTTP request headers

appDeploy

Example

Parameters

Return type

Authorization

HTTP request headers

appDeployRebuild

Example

Parameters

Return type

Authorization

HTTP request headers

appDeployRollback

Example

Parameters

Return type

Authorization

HTTP request headers

appDeployRollbackUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

appGrant

Example

Parameters

Return type

Authorization

HTTP request headers

appInfo

Example

Parameters

Return type

Authorization

HTTP request headers

appList

Example

Parameters

Return type

Authorization

HTTP request headers

appLog

Example

Parameters

Return type

Authorization

HTTP request headers

appRemove

Example

Parameters

Return type

Authorization

HTTP request headers

appRestart

Example

Parameters

Return type

Authorization

HTTP request headers

appRevoke