All pages
Powered by GitBook
1 of 5

Loading...

Loading...

Loading...

Loading...

Loading...

Metadata




Manage



Push


Apps

Metadata

Fetch app's metadata like name and version.

Push

Push a local app directory to ByteNite.

Manage

Activate, deactivate, and delete apps.

Pull

Download a ByteNite app locally.

Pull


Get distributed apps

get

List all distributed apps created by the user.

Use this endpoint to fetch apps created by the user.

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Query parameters
orderBystringOptional

Field name to sort apps by (e.g., createdAt).

pagination.limitinteger · int64Optional

Number of rows to return per page.

pagination.offsetinteger · int64Optional

Number of rows to skip before starting to collect the result set.

isPublicbooleanOptional

Filter public apps only

Responses
200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

get
/apps

Get the latest app details

get

Get the latest app de

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Path parameters
appTagstringRequired

Unique tag of the app

Responses
200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

get
/apps/{appTag}

Get status of app

get

Get status of app

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Path parameters
appTagstringRequired

Unique tag of the app

Responses
200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

get
/apps/{appTag}/status

Activate a distributed app

post

Activate a distributed app

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Path parameters
appTagstringRequired

Unique tag of the app

Responses
200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

post
/apps/{appTag}/activate

Activate a distributed app

post

Activate a distributed app

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Path parameters
appTagstringRequired

Unique tag of the app

Responses
200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

post
/apps/{appTag}/deactivate

Upload a distributed app

post

Upload a distributed app to the server

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Body
datastringRequired
Responses
200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

post
/apps

Get download link for an app

get

Get download link for an app

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Path parameters
appTagstringRequired

Unique tag of the app

Responses
200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

get
/apps/{appTag}/download
POST /v1/dev/apps/{appTag}/activate HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}
POST /v1/dev/apps/{appTag}/deactivate HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}
GET /v1/dev/apps/{appTag}/download HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}
GET /v1/dev/apps HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
GET /v1/dev/apps/{appTag} HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "app": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "video-transcoding",
    "version": "1.0",
    "owner": "b7aac91d-7e62-4923-898f-5c6d9ea48927",
    "status": "active",
    "deviceRequirements": {
      "minCpu": 1,
      "minMemory": 2,
      "gpu": [
        "tesla t4",
        "nvidia a100-sxm4-40gb"
      ]
    },
    "isPublic": true,
    "createdAt": "2025-12-13T04:38:06.443Z",
    "updatedAt": "2025-12-13T04:38:06.443Z",
    "platform": "docker",
    "hash": "Plv5qqtm1jPtm8Brq4jMj9u/zSJMQV85fl62UNxltcM=",
    "link": "text",
    "platformConfig": {
      "container": "python:latest",
      "privateImage": true,
      "username": "text",
      "token": "text",
      "secrets": [
        "text"
      ]
    },
    "entrypoint": "main.py",
    "revision": "text",
    "description": "text",
    "userName": "alice"
  }
}
GET /v1/dev/apps/{appTag}/status HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}
{
  "apps": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "video-transcoding",
      "version": "1.0",
      "owner": "b7aac91d-7e62-4923-898f-5c6d9ea48927",
      "status": "active",
      "deviceRequirements": {
        "minCpu": 1,
        "minMemory": 2,
        "gpu": [
          "tesla t4",
          "nvidia a100-sxm4-40gb"
        ]
      },
      "isPublic": true,
      "createdAt": "2025-12-13T04:38:06.443Z",
      "updatedAt": "2025-12-13T04:38:06.443Z",
      "platform": "docker",
      "hash": "Plv5qqtm1jPtm8Brq4jMj9u/zSJMQV85fl62UNxltcM=",
      "link": "text",
      "platformConfig": {
        "container": "python:latest",
        "privateImage": true,
        "username": "text",
        "token": "text",
        "secrets": [
          "text"
        ]
      },
      "entrypoint": "main.py",
      "revision": "text",
      "description": "text",
      "userName": "alice"
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  }
}
POST /v1/dev/apps HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "data": "text"
}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "video-transcoding",
  "version": "1.0",
  "owner": "b7aac91d-7e62-4923-898f-5c6d9ea48927",
  "status": "active",
  "deviceRequirements": {
    "minCpu": 1,
    "minMemory": 2,
    "gpu": [
      "tesla t4",
      "nvidia a100-sxm4-40gb"
    ]
  },
  "isPublic": true,
  "createdAt": "2025-12-13T04:38:06.443Z",
  "updatedAt": "2025-12-13T04:38:06.443Z",
  "platform": "docker",
  "hash": "Plv5qqtm1jPtm8Brq4jMj9u/zSJMQV85fl62UNxltcM=",
  "link": "text",
  "platformConfig": {
    "container": "python:latest",
    "privateImage": true,
    "username": "text",
    "token": "text",
    "secrets": [
      "text"
    ]
  },
  "entrypoint": "main.py",
  "revision": "text",
  "description": "text",
  "userName": "alice"
}