Metadata | ByteNite Docs

Home Go to Platform

Get distributed apps

get

List all distributed apps created by the user.

Use this endpoint to fetch apps created by the user.

Authorizations

Query parameters

orderByanyOptional

The field to order the results by.

pagination.limitanyOptional

Results per page

pagination.offsetanyOptional

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

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

GET /v1/dev/apps HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "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
      },
      "createdAt": "2025-05-01T16:47:03.788Z",
      "updatedAt": "2025-05-01T16:47:03.788Z",
      "platform": "docker",
      "hash": "Plv5qqtm1jPtm8Brq4jMj9u/zSJMQV85fl62UNxltcM=",
      "link": "text",
      "platformConfig": {
        "container": "text",
        "privateImage": true,
        "username": "text",
        "token": "text"
      },
      "entrypoint": "main.py",
      "revision": "text",
      "description": "text"
    }
  ]
}

Get the latest app details

get

Get the latest app de

Authorizations

Path parameters

appTaganyRequired

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

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
    },
    "createdAt": "2025-05-01T16:47:03.788Z",
    "updatedAt": "2025-05-01T16:47:03.788Z",
    "platform": "docker",
    "hash": "Plv5qqtm1jPtm8Brq4jMj9u/zSJMQV85fl62UNxltcM=",
    "link": "text",
    "platformConfig": {
      "container": "text",
      "privateImage": true,
      "username": "text",
      "token": "text"
    },
    "entrypoint": "main.py",
    "revision": "text",
    "description": "text"
  }
}

Get status of app

get

Get status of app

Authorizations

Path parameters

appTaganyRequired

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

GET /v1/dev/apps/{appTag}/status HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

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