Get dsp blocks

Retrieve all dsp blocks.

GET /api/organizations/{organizationId}/dsp

Try it

Get dsp blocks

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/dsp \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "dspBlocks": [
    {
      "id": 123,
      "name": "<string>",
      "dockerContainer": "<string>",
      "dockerContainerManagedByEdgeImpulse": true,
      "created": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "port": 123,
      "isConnected": true,
      "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,
      "error": "<string>"
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

dspBlocks · object[] · required

Show child attributes

dspBlocks. id · integer · required

dspBlocks. name · string · required

dspBlocks. dockerContainer · string · required

dspBlocks. dockerContainerManagedByEdgeImpulse · boolean · required

dspBlocks. created · string<date-time> · required

dspBlocks. description · string · required

dspBlocks. port · integer · required

dspBlocks. isConnected · boolean · required

dspBlocks. sourceCodeAvailable · boolean · required

dspBlocks. sourceCodeDownloadStaffOnly · boolean · required

Whether the source code is only available for staff users.

dspBlocks. createdByUser · object

Show child attributes

dspBlocks.createdByUser. id · integer · required

dspBlocks.createdByUser. name · string · required

dspBlocks.createdByUser. username · string · required

dspBlocks.createdByUser. photo · string

dspBlocks. lastUpdated · string<date-time>

dspBlocks. lastUpdatedByUser · object

Show child attributes

dspBlocks.lastUpdatedByUser. id · integer · required

dspBlocks.lastUpdatedByUser. name · string · required

dspBlocks.lastUpdatedByUser. username · string · required

dspBlocks.lastUpdatedByUser. photo · string

dspBlocks. userId · integer

dspBlocks. userName · string

dspBlocks. requestsCpu · number

dspBlocks. requestsMemory · integer

dspBlocks. limitsCpu · number

dspBlocks. limitsMemory · integer

dspBlocks. error · string

error · string

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