Skip to main content

HostInstanceApi

valkyrai-api

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

MethodHTTP requestDescription
deleteHostInstanceDELETE HostInstanceApiDelete a HostInstance.

deleteHostInstance

Void
deleteHostInstance(id)

Delete a HostInstance.

Deletes a specific HostInstance.

Example

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


HostInstanceApi apiInstance = new HostInstanceApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the HostInstance.

try {
Void result = apiInstance.deleteHostInstance(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling HostInstanceApi#deleteHostInstance");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the HostInstance.

Return type

Void

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getHostInstance

HostInstance
getHostInstance(id)

Retrieve a single HostInstance

Retrieves a single HostInstance for a specific uid.

Example

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


HostInstanceApi apiInstance = new HostInstanceApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the HostInstance.

try {
HostInstance result = apiInstance.getHostInstance(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling HostInstanceApi#getHostInstance");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the HostInstance.

Return type

HostInstance

Authorization

No authorization required

HTTP request headers

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

getHostInstanceList

HostInstance
getHostInstanceList(pagesizesort)

Retrieve a list of HostInstances

Retrieves a list of HostInstances.

Example

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


HostInstanceApi apiInstance = new HostInstanceApi();
Integer page = 0; // Integer |
Integer size = 20; // Integer |
List<String> sort = Arrays.asList(); // List<String> |

try {
HostInstance result = apiInstance.getHostInstanceList(pagesizesort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling HostInstanceApi#getHostInstanceList");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
pageInteger[optional] [default to 0]
sizeInteger[optional] [default to 20]
sortList<String>[optional]

Return type

HostInstance

Authorization

No authorization required

HTTP request headers

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

postHostInstance

HostInstance
postHostInstance(hostInstance)

Create a new HostInstance

Creates a new HostInstance.

Example

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


HostInstanceApi apiInstance = new HostInstanceApi();
HostInstance hostInstance = new HostInstance(); // HostInstance | HostInstance details.

try {
HostInstance result = apiInstance.postHostInstance(hostInstance);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling HostInstanceApi#postHostInstance");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
hostInstanceHostInstanceHostInstance details.

Return type

HostInstance

Authorization

No authorization required

HTTP request headers

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

updateHostInstance

HostInstance
updateHostInstance(idhostInstance)

Update an existing HostInstance

Updates an existing HostInstance.

Example

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


HostInstanceApi apiInstance = new HostInstanceApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the HostInstance.
HostInstance hostInstance = new HostInstance(); // HostInstance | Updated HostInstance details.

try {
HostInstance result = apiInstance.updateHostInstance(idhostInstance);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling HostInstanceApi#updateHostInstance");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the HostInstance.
hostInstanceHostInstanceUpdated HostInstance details.

Return type

HostInstance

Authorization

No authorization required

HTTP request headers

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

Generated Version Details

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0.1-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2025-09-03T16:35:42.569765-07:00[America/Los_Angeles]