bitbucket-api-client-lib

DeploymentsApi

All URIs are relative to https://api.bitbucket.org/2.0

Method	HTTP request	Description
createEnvironment	POST /repositories/{workspace}/{repo_slug}/environments/
deleteEnvironmentForRepository	DELETE /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}
getDeploymentForRepository	GET /repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}
getDeploymentsForRepository	GET /repositories/{workspace}/{repo_slug}/deployments/
getEnvironmentForRepository	GET /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}
getEnvironmentsForRepository	GET /repositories/{workspace}/{repo_slug}/environments/
updateEnvironmentForRepository	POST /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes/

createEnvironment

DeploymentEnvironment createEnvironment(body, username, repoSlug)

Create an environment.

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
DeploymentEnvironment body = new DeploymentEnvironment(); // DeploymentEnvironment | The environment to create.
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    DeploymentEnvironment result = apiInstance.createEnvironment(body, username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#createEnvironment");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	DeploymentEnvironment	The environment to create.
username	String	The account.
repoSlug	String	The repository.

Return type

DeploymentEnvironment

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteEnvironmentForRepository

deleteEnvironmentForRepository(username, repoSlug, environmentUuid)

Delete an environment

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String environmentUuid = "environmentUuid_example"; // String | The environment UUID.
try {
    apiInstance.deleteEnvironmentForRepository(username, repoSlug, environmentUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#deleteEnvironmentForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
environmentUuid	String	The environment UUID.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getDeploymentForRepository

Deployment getDeploymentForRepository(username, repoSlug, deploymentUuid)

Retrieve a deployment

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String deploymentUuid = "deploymentUuid_example"; // String | The deployment UUID.
try {
    Deployment result = apiInstance.getDeploymentForRepository(username, repoSlug, deploymentUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#getDeploymentForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
deploymentUuid	String	The deployment UUID.

Return type

Deployment

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getDeploymentsForRepository

PaginatedDeployments getDeploymentsForRepository(username, repoSlug)

Find deployments

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PaginatedDeployments result = apiInstance.getDeploymentsForRepository(username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#getDeploymentsForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

PaginatedDeployments

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getEnvironmentForRepository

DeploymentEnvironment getEnvironmentForRepository(username, repoSlug, environmentUuid)

Retrieve an environment

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String environmentUuid = "environmentUuid_example"; // String | The environment UUID.
try {
    DeploymentEnvironment result = apiInstance.getEnvironmentForRepository(username, repoSlug, environmentUuid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#getEnvironmentForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
environmentUuid	String	The environment UUID.

Return type

DeploymentEnvironment

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getEnvironmentsForRepository

PaginatedEnvironments getEnvironmentsForRepository(username, repoSlug)

Find environments

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
try {
    PaginatedEnvironments result = apiInstance.getEnvironmentsForRepository(username, repoSlug);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#getEnvironmentsForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.

Return type

PaginatedEnvironments

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateEnvironmentForRepository

updateEnvironmentForRepository(username, repoSlug, environmentUuid)

Update an environment

Example

// Import classes:
//import com.rappi.bitbucket.client.invoker.ApiException;
//import com.rappi.bitbucket.client.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
String username = "username_example"; // String | The account.
String repoSlug = "repoSlug_example"; // String | The repository.
String environmentUuid = "environmentUuid_example"; // String | The environment UUID.
try {
    apiInstance.updateEnvironmentForRepository(username, repoSlug, environmentUuid);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#updateEnvironmentForRepository");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The account.
repoSlug	String	The repository.
environmentUuid	String	The environment UUID.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

This site is open source. Improve this page.