# Variable DeploymentApi`Const`

DeploymentApi: {
_defaultBasePath: undefined;
deploymentBatchModify: (
body: AiDeploymentBulkModificationRequest,
headerParameters: { "AI-Resource-Group": string },
) => OpenApiRequestBuilder<AiDeploymentBulkModificationResponse>;
deploymentCount: (
queryParameters: {
configurationId?: string;
executableIds?: string[];
scenarioId?: string;
status?:
| "PENDING"
| "RUNNING"
| "COMPLETED"
| "DEAD"
| "STOPPING"
| "STOPPED"
| "UNKNOWN";
},
headerParameters: { "AI-Resource-Group": string },
) => OpenApiRequestBuilder<number>;
deploymentCreate: (
body: AiDeploymentCreationRequest,
headerParameters: { "AI-Resource-Group": string },
) => OpenApiRequestBuilder<AiDeploymentCreationResponse>;
deploymentDelete: (
deploymentId: string,
headerParameters: { "AI-Resource-Group": string },
) => OpenApiRequestBuilder<AiDeploymentDeletionResponse>;
deploymentGet: (
deploymentId: string,
queryParameters: { $select?: "status" },
headerParameters: { "AI-Resource-Group": string },
) => OpenApiRequestBuilder<AiDeploymentResponseWithDetails>;
deploymentModify: (
deploymentId: string,
body: AiDeploymentModificationRequest,
headerParameters: { "AI-Resource-Group": string },
) => OpenApiRequestBuilder<AiDeploymentModificationResponse>;
deploymentQuery: (
queryParameters: {
$select?: "status";
$skip?: number;
$top?: number;
configurationId?: string;
executableIds?: string[];
scenarioId?: string;
status?:
| "PENDING"
| "RUNNING"
| "COMPLETED"
| "DEAD"
| "STOPPING"
| "STOPPED"
| "UNKNOWN";
},
headerParameters: { "AI-Resource-Group": string },
) => OpenApiRequestBuilder<AiDeploymentList>;
kubesubmitV4DeploymentsGetLogs: (
deploymentId: string,
queryParameters?: {
$order?: "asc" | "desc";
$top?: number;
end?: string;
start?: string;
},
headerParameters?: { Authorization?: string },
) => OpenApiRequestBuilder<RTALogCommonResponse>;
}

Representation of the 'DeploymentApi'. This API is part of the 'AI_CORE_API' service.

#### Type Declaration

- ##### _defaultBasePath: undefined

- ##### deploymentBatchModify: (
  body: AiDeploymentBulkModificationRequest,
  headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<AiDeploymentBulkModificationResponse>

  Update status of multiple deployments. stop or delete multiple deployments.

- ##### deploymentCount: (
  queryParameters: {
  configurationId?: string;
  executableIds?: string[];
  scenarioId?: string;
  status?:
  | "PENDING"
  | "RUNNING"
  | "COMPLETED"
  | "DEAD"
  | "STOPPING"
  | "STOPPED"
  | "UNKNOWN";
  },
  headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<number>

  Retrieve the number of available deployments. The number can be filtered by scenarioId, configurationId, executableIdsList or by deployment status.

- ##### deploymentCreate: (
  body: AiDeploymentCreationRequest,
  headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<AiDeploymentCreationResponse>

  Create a deployment using the configuration specified by configurationId after synchronously checking the correctness of the configuration.

- ##### deploymentDelete: (
  deploymentId: string,
  headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<AiDeploymentDeletionResponse>

  Mark deployment with deploymentId as deleted.

- ##### deploymentGet: (
  deploymentId: string,
  queryParameters: { $select?: "status" },
  headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<AiDeploymentResponseWithDetails>

  Retrieve details for execution with deploymentId.

- ##### deploymentModify: (
  deploymentId: string,
  body: AiDeploymentModificationRequest,
  headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<AiDeploymentModificationResponse>

  Update target status of a deployment to stop a deployment or change the configuration to be used by the deployment after synchronously checking the correctness of the configuration. A change of configuration is only allowed for RUNNING and PENDING deployments.

- ##### deploymentQuery: (
  queryParameters: {
  $select?: "status";
  $skip?: number;
  $top?: number;
  configurationId?: string;
  executableIds?: string[];
  scenarioId?: string;
  status?:
  | "PENDING"
  | "RUNNING"
  | "COMPLETED"
  | "DEAD"
  | "STOPPING"
  | "STOPPED"
  | "UNKNOWN";
  },
  headerParameters: { "AI-Resource-Group": string },
  ) => OpenApiRequestBuilder<AiDeploymentList>

  Retrieve a list of deployments that match the specified filter criteria. Filter criteria include a list of executableIds, a scenarioId, a configurationId, or a deployment status. With top/skip parameters it is possible to paginate the result list. With select parameter it is possible to select only status.

- ##### kubesubmitV4DeploymentsGetLogs: (
  deploymentId: string,
  queryParameters?: {
  $order?: "asc" | "desc";
  $top?: number;
  end?: string;
  start?: string;
  },
  headerParameters?: { Authorization?: string },
  ) => OpenApiRequestBuilder<RTALogCommonResponse>

  Retrieve logs of a deployment for getting insight into the deployment results or failures.

  Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.

- Defined in packages/ai-api/dist/client/AI_CORE_API/deployment-api.d.ts:7