Skip to main content
GET
/
api
/
organizations
/
{organizationId}
/
deploy
/
{deployId}
Get deploy block
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/deploy/{deployId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "deployBlock": {
    "id": 123,
    "name": "<string>",
    "dockerContainer": "<string>",
    "dockerContainerManagedByEdgeImpulse": true,
    "created": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "cliArguments": "<string>",
    "photo": "<string>",
    "privileged": true,
    "mountLearnBlock": true,
    "supportsEonCompiler": true,
    "showOptimizations": true,
    "category": "library",
    "sourceCodeAvailable": true,
    "sourceCodeDownloadStaffOnly": true,
    "createdByUser": {
      "id": 123,
      "name": "<string>",
      "username": "<string>",
      "photo": "<string>"
    },
    "lastUpdated": "2023-11-07T05:31:56Z",
    "lastUpdatedByUser": {
      "id": 123,
      "name": "<string>",
      "username": "<string>",
      "photo": "<string>"
    },
    "userId": 123,
    "userName": "<string>",
    "requestsCpu": 123,
    "requestsMemory": 123,
    "limitsCpu": 123,
    "limitsMemory": 123,
    "integrateUrl": "<string>",
    "parameters": [
      {}
    ],
    "parametersUI": [
      {
        "name": "Scale axes",
        "defaultValue": "<string>",
        "type": "text",
        "param": "scale-axes",
        "readonly": true,
        "shouldShow": true,
        "required": true,
        "showClickToSet": true,
        "value": "<string>",
        "help": "Divide axes by this number",
        "selectOptions": [
          {
            "value": "<string>",
            "selected": true,
            "optionLabel": "<string>",
            "priority": 123,
            "romEstimate": 123,
            "needsOps": [
              "<string>"
            ],
            "needsFeatures": [
              "<string>"
            ]
          }
        ],
        "showIf": {
          "parameter": "<string>",
          "operator": "eq",
          "value": "<string>"
        },
        "invalidText": "<string>",
        "section": "advanced",
        "multiline": true,
        "hint": "<string>",
        "placeholder": "<string>",
        "valid": [
          {}
        ],
        "items": {},
        "properties": {},
        "minVal": 123,
        "maxVal": 123
      }
    ]
  },
  "error": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

deployId
integer
required

Deploy block ID.

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

deployBlock
object
required
error
string

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