All pages
Powered by GitBook
1 of 1

Loading...

Templates




Upload a template

post

Upload a template to the server

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Body

The templates specific to each app are stored in this table.

idstringOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
isPublicbooleanOptional
partitionerstringOptional
assemblerstringOptional
userNamestringOptional

User name of the template owner.

Example: alice
descriptionstringOptional
appstringOptional
ownerstringOptional
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
/templates

Get a template

get

Get a template by id

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Path parameters
idstringRequired
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
/templates/{id}

Get templates

get

List all templates 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 templates 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
/templates
{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}
POST /v1/dev/templates HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 562

{
  "id": "text",
  "createdAt": "2025-12-13T04:38:06.443Z",
  "updatedAt": "2025-12-13T04:38:06.443Z",
  "isPublic": true,
  "partitioner": "text",
  "assembler": "text",
  "dataSource": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "dataDestination": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "params": {
    "partitioner": {},
    "app": {},
    "assembler": {}
  },
  "config": {
    "taskTimeout": 1,
    "jobTimeout": 1,
    "isTestJob": true,
    "maxTaskRetries": 1
  },
  "userName": "alice",
  "description": "text",
  "app": "text",
  "owner": "text"
}
GET /v1/dev/templates/{id} HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": "text",
  "createdAt": "2025-12-13T04:38:06.443Z",
  "updatedAt": "2025-12-13T04:38:06.443Z",
  "isPublic": true,
  "partitioner": "text",
  "assembler": "text",
  "dataSource": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "dataDestination": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "params": {
    "partitioner": {},
    "app": {},
    "assembler": {}
  },
  "config": {
    "taskTimeout": 1,
    "jobTimeout": 1,
    "isTestJob": true,
    "maxTaskRetries": 1
  },
  "userName": "alice",
  "description": "text",
  "app": "text",
  "owner": "text"
}
GET /v1/dev/templates HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "templates": [
    {
      "id": "text",
      "createdAt": "2025-12-13T04:38:06.443Z",
      "updatedAt": "2025-12-13T04:38:06.443Z",
      "isPublic": true,
      "partitioner": "text",
      "assembler": "text",
      "dataSource": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "dataDestination": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "params": {
        "partitioner": {},
        "app": {},
        "assembler": {}
      },
      "config": {
        "taskTimeout": 1,
        "jobTimeout": 1,
        "isTestJob": true,
        "maxTaskRetries": 1
      },
      "userName": "alice",
      "description": "text",
      "app": "text",
      "owner": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  }
}