Apps

PreviousDeveloper API NextValidate

Last updated 17 days ago

Was this helpful?

Get distributed app details

Get distributed apps by id

get

/apps/{appId}

Authorizations

Path parameters

appIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.bytenite.com/v1/dev/apps/{appId}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "app": {
    "id": "video-transcoding",
    "platform": "docker",
    "version": {
      "major": 1,
      "minor": 0,
      "tag": 0
    },
    "hash": "Plv5qqtm1jPtm8Brq4jMj9u/zSJMQV85fl62UNxltcM=",
    "platformConfig": {
      "container": "python:latest"
    },
    "createdAt": "2025-02-22T04:45:04.970Z",
    "updatedAt": "2025-02-22T04:45:04.970Z",
    "owner": "b7aac91d-7e62-4923-898f-5c6d9ea48927",
    "entrypoint": "main.py",
    "deviceRequirements": {
      "minCpu": 1,
      "minMemory": 2
    },
    "status": "active"
  }
}

A successful response.

Get distributed apps

List all distributed apps created by the user.

Use this endpoint to fetch apps created by the user.

get

/apps

Authorizations

Query parameters

orderBystring

pagination.limitinteger · int64

Results per page

pagination.offsetinteger · int64

The number of items to skip before starting to collect the result set

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.bytenite.com/v1/dev/apps' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "apps": [
    {
      "id": "video-transcoding",
      "platform": "docker",
      "version": {
        "major": 1,
        "minor": 0,
        "tag": 0
      },
      "hash": "Plv5qqtm1jPtm8Brq4jMj9u/zSJMQV85fl62UNxltcM=",
      "platformConfig": {
        "container": "python:latest"
      },
      "createdAt": "2025-02-22T04:45:04.970Z",
      "updatedAt": "2025-02-22T04:45:04.970Z",
      "owner": "b7aac91d-7e62-4923-898f-5c6d9ea48927",
      "entrypoint": "main.py",
      "deviceRequirements": {
        "minCpu": 1,
        "minMemory": 2
      },
      "status": "active"
    }
  ]
}

A successful response.

Upload a distributed app

Upload a distributed app to the server

post

/apps

Authorizations

Body

datastring · byte

The tar archive

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.bytenite.com/v1/dev/apps' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "app": {
    "id": "video-transcoding",
    "platform": "docker",
    "version": {
      "major": 1,
      "minor": 0,
      "tag": 0
    },
    "hash": "Plv5qqtm1jPtm8Brq4jMj9u/zSJMQV85fl62UNxltcM=",
    "platformConfig": {
      "container": "python:latest"
    },
    "createdAt": "2025-02-22T04:45:04.970Z",
    "updatedAt": "2025-02-22T04:45:04.970Z",
    "owner": "b7aac91d-7e62-4923-898f-5c6d9ea48927",
    "entrypoint": "main.py",
    "deviceRequirements": {
      "minCpu": 1,
      "minMemory": 2
    },
    "status": "active"
  }
}

A successful response.

Activate a distributed app

post

/apps/{appId}/activate

Authorizations

Path parameters

appIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.bytenite.com/v1/dev/apps/{appId}/activate' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "ok": true,
  "requestId": "text",
  "message": "text",
  "error": {
    "code": 1,
    "message": "text",
    "description": "text"
  }
}

A successful response.

Activate a distributed app

post

/apps/{appId}/deactivate

Authorizations

Path parameters

appIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.bytenite.com/v1/dev/apps/{appId}/deactivate' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "ok": true,
  "requestId": "text",
  "message": "text",
  "error": {
    "code": 1,
    "message": "text",
    "description": "text"
  }
}

A successful response.

Get status of app by id

get

/apps/{appId}/status

Authorizations

Path parameters

appIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.bytenite.com/v1/dev/apps/{appId}/status' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "ok": true,
  "requestId": "text",
  "message": "text",
  "error": {
    "code": 1,
    "message": "text",
    "description": "text"
  }
}

A successful response.