--- title: "List deployment history" method: GET path: "/api/{projectId}/deployment/history" tags: ["Deployment"] --- # List deployment history `GET /api/{projectId}/deployment/history` ## Request - Base URL: `https://studio.edgeimpulse.com/v1` - URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/deployment/history` - Auth: one of: - API key in header `x-api-key` - API key in cookie `jwt` - API key in header `x-jwt-token` - OAuth 2 - Authorization code: `/v1/oauth/authorize` - Client credentials - Implicit: `/v1/oauth/authorize` - Password - Token URL: `/v1/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Lists all successfully built deployments. ## Path parameters - `projectId` integer, required ## Query parameters - `impulseId` integer - `deploymentFormat` string - `limit` integer - `offset` integer ## Response `200` OK - ListDeploymentHistoryResponse - `success` boolean, required: Whether the operation succeeded - `error` string: Optional error description (set if 'success' was false) - `deployments` DeploymentHistory[], required - `created` string, date-time, required: Date when the model was deployed - `deploymentVersion` integer, required - `deploymentFormat` string, required - `deploymentTarget` ProjectDeploymentTarget - `name` string, required - `description` string, required - `image` string, required - `imageClasses` string, required - `format` string, required - `latencyDevice` string - `hasEonCompiler` boolean, required: Preferably use supportedEngines / preferredEngine - `hasTensorRT` boolean, required: Preferably use supportedEngines / preferredEngine - `hasTensaiFlow` boolean, required: Preferably use supportedEngines / preferredEngine - `hasDRPAI` boolean, required: Preferably use supportedEngines / preferredEngine - `hasTIDL` boolean, required: Preferably use supportedEngines / preferredEngine - `hasAkida` boolean, required: Preferably use supportedEngines / preferredEngine - `hasMemryx` boolean, required: Preferably use supportedEngines / preferredEngine - `hasStAton` boolean, required: Preferably use supportedEngines / preferredEngine - `hasCevaNpn` boolean, required: Preferably use supportedEngines / preferredEngine - `hasNordicAxon` boolean, required: Preferably use supportedEngines / preferredEngine - `hasQaic` boolean, required: Preferably use supportedEngines / preferredEngine - `hideOptimizations` boolean, required - `badge` object - `name` string, required - `description` string, required - `uiSection` 'library' | 'firmware' | 'mobile' | 'hidden', required - `customDeployId` integer - `customDeployOrganizationId` integer - `integrateUrl` string - `ownerOrganizationName` string - `supportedEngines` DeploymentTargetEngine[], required - `preferredEngine` 'tflite' | 'tflite-eon' | 'tflite-eon-ram-optimized' | 'tensorrt' | 'tensaiflow' | 'drp-ai' | 'tidl' | 'akida' | 'syntiant' | 'memryx' | 'neox' | 'ethos-linux' | 'st-aton' | 'ceva-npn' | 'nordic-axon' | 'vlm-connector' | 'qaic', required - `url` string - `docsUrl` string, required - `firmwareRepoUrl` string - `modelVariants` DeploymentTargetVariant[], required - `variant` 'int8' | 'float32' | 'akida', required - `supported` boolean, required - `hint` string - `parameters` DSPGroupItem[], required - `name` string, required - `value` string - `defaultValue` string, required - `type` string, required - `help` string - `param` string, required - `selectOptions` object[] - `value` string: What is the string that will be set if this option is selected? - `selected` boolean - `optionLabel` string: What is the label that will be shown to the user for this option? - `priority` number: The following options are optional. See Learn Block Auto Config in Notion. Higher priority will get chosen based on limits below. - `romEstimate` number: Estimated ROM footprint for this choice. Will be tested against ROM budget in Studio. - `needsOps` string[] - `needsFeatures` string[] - `readonly` boolean, required - `shouldShow` boolean, required - `showIf` object - `parameter` string, required - `operator` 'eq' | 'neq', required - `value` string, required - `invalidText` string - `section` 'advanced' | 'augmentation' | 'modelProfiling': Interface section to render parameter in. - `multiline` boolean: Only valid for type "string". Will render a multiline text area. - `required` boolean, required - `hint` string: If set, shows a hint below the input. - `placeholder` string: Sets the placeholder text on the input element (for types "string", "int", "float" and "secret") - `showClickToSet` boolean, required: If enabled, render a disabled input element with 'Click to set' - `valid` object[]: Valid values for parameter. - `items` object: Recursive definition for items of a parameter with type 'array'. - `properties` object: Recursive definition for a parameter with type 'object'. - `minVal` number: Minimum value for parameters of type 'int' or 'float'. - `maxVal` number: Maximum value for parameters of type 'int' or 'float'. - `redirect` object: An optional redirect field for integration partners to be shown in addition to the docs link, i.e. for directing users to a partner's website or application once deployment completes. This is experimental and may change in the future. - `url` string - `text` string - `recommendedForProject` boolean, required: Whether this deployment target is recommended for the project based on connected devices. - `disabledForProject` boolean, required: Whether this deployment target is disabled for the project based on various attributes of the project. - `reasonTargetDisabled` string: If the deployment target is disabled for the project, this gives the reason why. - `engine` 'tflite' | 'tflite-eon' | 'tflite-eon-ram-optimized' | 'tensorrt' | 'tensaiflow' | 'drp-ai' | 'tidl' | 'akida' | 'syntiant' | 'memryx' | 'neox' | 'ethos-linux' | 'st-aton' | 'ceva-npn' | 'nordic-axon' | 'vlm-connector' | 'qaic', required - `modelType` 'int8' | 'float32' | 'akida' | 'requiresRetrain' - `impulseId` integer, required - `impulseName` string, required - `impulseIsDeleted` boolean, required - `createdByUser` CreatedUpdatedByUser - `id` integer, required - `name` string, required - `username` string, required - `photo` string - `impulseHasChangedSinceDeployment` boolean, required: Set to true if the deployment no longer exactly matches the impulse it was created from (e.g. model was trained since the deployment was created, or some thresholds have changed) - `downloadUrl` string, required - `createdByBuildPublicDeploymentJob` boolean, required: If set, then this deployment was created by an anonymous user through buildPublicDeploymentJob. - `datasetVersion` DatasetVersion - `id` integer, required: Unique identifier of this dataset version. - `created` string, date-time, required: Date and time when this dataset version was created. - `versionIndex` integer, required: A sequential index of this dataset version, starting at 0 for the first version. - `description` string, nullable, required: User-editable description of this dataset version. - `parentVersionId` integer, nullable, required: ID of the parent dataset version this version is derived from. Null for the first dataset version. - `restoredFromDatasetVersionId` integer, nullable: ID of the dataset version this version was restored from. Null if not restored. - `type` 'auto_save' | 'restore' | 'manual', required - `summary` DatasetVersionSummary, required - `rawEventCountInWindow` number, required: Total number of raw mutation events in this dataset version window. A single sample can contribute multiple events, for example, an insert followed by an update. - `sampleChangesCount` number, required: Total number of distinct samples that changed in this dataset version window. Each sample is counted once, even if it has multiple mutation events. - `actionCounts` object, required: Number of samples with mutation events in this window, grouped by action type. Each action-type count is at most the number of changed samples, but sums across action types can be higher because one sample can contribute to multiple action types. - `insert` number: Number of samples in this window with at least one insert mutation. - `update` number: Number of samples in this window with at least one update mutation. - `delete` number: Number of samples in this window with at least one delete mutation. - `windowStart` string, date-time, required: Date and time when this dataset version window opened. - `windowEnd` string, date-time, required: Date and time when this dataset version window closed. - `actors` union[], required: Actors who contributed at least one change in this dataset version window. - union - ActorUser - `id` integer, required - `name` string, required - `username` string, required - `photo` string - `type` 'user', required - ActorOAuthClient - `type` 'oauthClient', required - `id` integer, required - `clientId` string, required - `name` string, required - `logoUrl` string - `user` CreatedUpdatedByUser - … - ActorProjectApiKey - `type` 'projectApiKey', required - `name` string, required - `created` string, date-time, required - `createdByUser` CreatedUpdatedByUser - … - `artifactDigest` string: SHA-256 digest of the exact artifact returned by downloadHistoricDeployment. Omitted for deployments created before artifact digests were recorded. - `totalDeploymentCount` integer, required --- [API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)