Deployment

List deployment history

Lists all successfully built deployments.

get/api/{projectId}/deployment/history

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/deployment/history/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset, data for all impulses is returned.

deploymentFormatstring

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

totalDeploymentCountinteger required

Example response

{
  "deployments": [
    {
      "deploymentTarget": {
        "parameters": [
          {
            "name": "Scale axes",
            "type": "text",
            "help": "Divide axes by this number",
            "param": "scale-axes"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.