DeploymentsApi

valkyrai-api

All URIs are relative to http://localhost:8080/v1

Method	HTTP request	Description
createDeploymentSpec	POST DeploymentsApi	Create deployment specification

createDeploymentSpec

DeploymentSpec

createDeploymentSpec(deploymentSpec)

Create deployment specification

Create a deployment spec from app + build artifact + cloud config

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
DeploymentSpec deploymentSpec = new DeploymentSpec(); // DeploymentSpec | 

try {
    DeploymentSpec result = apiInstance.createDeploymentSpec(deploymentSpec);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#createDeploymentSpec");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
deploymentSpec	DeploymentSpec

Return type

DeploymentSpec

Authorization

No authorization required

HTTP request headers

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

deployApplication

Deployment

deployApplication(deploymentSpec)

Deploy application

Execute deployment to selected cloud platform (AWS/GCP/Azure/Fly.io)

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
DeploymentSpec deploymentSpec = new DeploymentSpec(); // DeploymentSpec | 

try {
    Deployment result = apiInstance.deployApplication(deploymentSpec);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#deployApplication");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
deploymentSpec	DeploymentSpec

Return type

Deployment

Authorization

No authorization required

HTTP request headers

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

getDeploymentStatus

Deployment

getDeploymentStatus(deploymentId)

Get deployment status

Check the status of an in-progress or completed deployment

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
UUID deploymentId = UUID.randomUUID(); // UUID | 

try {
    Deployment result = apiInstance.getDeploymentStatus(deploymentId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#getDeploymentStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
deploymentId	UUID

Return type

Deployment

Authorization

No authorization required

HTTP request headers

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

listDeployableApplications

ListDeployableApplications200ResponseInner

listDeployableApplications()

List deployable applications

Returns applications with available build artifacts ready for deployment

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();

try {
    ListDeployableApplications200ResponseInner result = apiInstance.listDeployableApplications();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#listDeployableApplications");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ListDeployableApplications200ResponseInner

Authorization

No authorization required

HTTP request headers

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

listDeploymentTemplates

DeploymentTemplate

listDeploymentTemplates(provider)

List deployment templates

Returns pre-configured deployment templates for quick setup

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
String provider = "aws"; // String | 

try {
    DeploymentTemplate result = apiInstance.listDeploymentTemplates(provider);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#listDeploymentTemplates");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
provider	String		[optional] [enum: aws, gcp, azure, fly]

Return type

DeploymentTemplate

Authorization

No authorization required

HTTP request headers

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

listDeployments

Deployment

listDeployments(statuslimit)

List recent deployments

Returns list of recent deployment operations

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
String status = "pending"; // String | 
Integer limit = 20; // Integer | 

try {
    Deployment result = apiInstance.listDeployments(statuslimit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#listDeployments");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
status	String		[optional] [enum: pending, provisioning, running, updating, failed, stopped, terminated]
limit	Integer		[optional] [default to 20]

Return type

Deployment

Authorization

No authorization required

HTTP request headers

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

scanBuildArtifacts

ScanBuildArtifacts200Response

scanBuildArtifacts(scanBuildArtifactsRequest)

Scan for built artifacts

Scans filesystem for JAR and frontend dist folders matching an application

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
ScanBuildArtifactsRequest scanBuildArtifactsRequest = new ScanBuildArtifactsRequest(); // ScanBuildArtifactsRequest | 

try {
    ScanBuildArtifacts200Response result = apiInstance.scanBuildArtifacts(scanBuildArtifactsRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#scanBuildArtifacts");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
scanBuildArtifactsRequest	ScanBuildArtifactsRequest

Return type

ScanBuildArtifacts200Response

Authorization

No authorization required

HTTP request headers

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

validateDeploymentSpec

ValidateDeploymentSpec200Response

validateDeploymentSpec(deploymentSpec)

Validate deployment configuration

Validates that deployment spec is valid and ready to execute

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.DeploymentsApi;


DeploymentsApi apiInstance = new DeploymentsApi();
DeploymentSpec deploymentSpec = new DeploymentSpec(); // DeploymentSpec | 

try {
    ValidateDeploymentSpec200Response result = apiInstance.validateDeploymentSpec(deploymentSpec);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DeploymentsApi#validateDeploymentSpec");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
deploymentSpec	DeploymentSpec

Return type

ValidateDeploymentSpec200Response

Authorization

No authorization required

HTTP request headers

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

Generated Version Details

~	value
GENERATOR VERSION	com.valkyrlabs:ValkyrAI API 1.0.3-SNAPSHOT
API ARTIFACT	com.valkyrlabs.valkyrai-api.jar
GENERATOR VERSION	org.openapitools.openapi-generator:7.5.0
GENERATOR CLASS	org.openapitools.codegen.languages.SpringCodegen
GENERATED DATE	2026-05-16T11:45:23.900207-07:00[America/Los_Angeles]