Update deployments

Update one application.

PATCH /v1/ai/deployments/{owner}/{name}

Addresshttps://api.hanzo.ai/v1/ai/deployments/{owner}/{name}
MethodPATCH
Operationpatch_ai_deployments_by_owner_by_name
AuthAuthorization: Bearer $HANZO_API_KEY

Update one application. PATCH and PUT reach the same handler, which has always taken a whole object.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
ownerpathstringyes
namepathstringyes
(body)bodyobjectyes

Response

StatusBodyMeaning
200Envelope.
401—No credential, or one this service does not accept.
403—A valid credential that may not do this.

200 body — 68 fields.

FieldInTypeAlwaysDescription
databodyany—The operation's own result.
data2bodyany—A second result the operation defines, when it has one.
msgbodystringyesEmpty on success, the reason on failure.
statusbodystringyesOne of ok, error.
data.basicConfigOptionsbodyApplicationConfigOption[]—
data.basicConfigOptions[].parameterbodystring—
data.basicConfigOptions[].settingbodystring—
data.createdTimebodystring—
data.descriptionbodystring—
data.detailsbodyApplicationView—
data.details.createdTimebodystring—
data.details.credentialsbodyEnvVariable[]—
data.details.credentials[].namebodystring—
data.details.credentials[].valuebodystring—
data.details.deploymentsbodyDeploymentDetail[]—
data.details.deployments[].containersbodyContainerDetail[]—
data.details.deployments[].containers[].imagebodystring—
data.details.deployments[].containers[].namebodystring—
data.details.deployments[].containers[].resourcesbodyResourceRequests—
data.details.deployments[].containers[].resources.cpubodystring—
data.details.deployments[].containers[].resources.memorybodystring—
data.details.deployments[].createdTimebodystring—
data.details.deployments[].namebodystring—
data.details.deployments[].readyReplicasbodyinteger—
data.details.deployments[].replicasbodyinteger—
data.details.deployments[].statusbodystring—
data.details.eventsbodyApplicationEvent[]—
data.details.events[].countbodyinteger—
data.details.events[].firstTimebodystring—
data.details.events[].involvedObjectbodystring—
data.details.events[].lastTimebodystring—
data.details.events[].messagebodystring—
data.details.events[].namebodystring—
data.details.events[].reasonbodystring—
data.details.events[].sourcebodystring—
data.details.events[].typebodystring—
data.details.metricsbodyResourceMetrics—
data.details.metrics.cpuPercentagebodynumber—
data.details.metrics.cpuUsagebodystring—
data.details.metrics.memoryPercentagebodynumber—
data.details.metrics.memoryUsagebodystring—
data.details.metrics.podCountbodyinteger—
data.details.namespacebodystring—
data.details.servicesbodyServiceDetail[]—
data.details.services[].clusterIPbodystring—
data.details.services[].createdTimebodystring—
data.details.services[].externalHostbodystring—
data.details.services[].externalIPbodystring—
data.details.services[].internalHostbodystring—
data.details.services[].namebodystring—
data.details.services[].portsbodyServicePort[]—
data.details.services[].ports[].namebodystring—
data.details.services[].ports[].nodePortbodyinteger—
data.details.services[].ports[].portbodyinteger—
data.details.services[].ports[].protocolbodystring—
data.details.services[].ports[].urlbodystring—
data.details.services[].typebodystring—
data.details.statusbodystring—
data.displayNamebodystring—
data.manifestbodystring—
data.namebodystring—
data.namespacebodystring—
data.ownerbodystring—
data.parametersbodystring—
data.statusbodystring—
data.templatebodystring—
data.updatedTimebodystring—
data.urlbodystring—

Failure carries the platform error shape — see Errors.

Examples

hanzo ai deployments owner update <owner> <name>
import { Configuration, AiApi } from 'hanzoai';

const api = new AiApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchAiDeploymentsByOwnerByName({ owner: 'owner', name: 'name' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AiApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AiApi(client).patch_ai_deployments_by_owner_by_name(owner='owner', name='name')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.AiAPI.PatchAiDeploymentsByOwnerByName(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, ai_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = ai_api::patch_ai_deployments_by_owner_by_name(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AiApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new AiApi(client).patchAiDeploymentsByOwnerByName();
curl -X PATCH https://api.hanzo.ai/v1/ai/deployments/<owner>/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP declares no tool for ai — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.


AI API · All Hanzo APIs · Interactive reference

Was this page useful?