Vibengine
API Reference

Templates

/v3/templates

POST
/v3/templates

Authorization

X-API-Key<token>

In: header

Request Body

application/json

body*unknown

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.vibengine.app/v3/templates" \  -H "Content-Type: application/json" \  -d '{}'
{
  "templateID": "string",
  "buildID": "string",
  "public": true,
  "names": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "aliases": [
    "string"
  ]
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/v2/templates

POST
/v2/templates

Authorization

X-API-Key<token>

In: header

Request Body

application/json

body*unknown

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.vibengine.app/v2/templates" \  -H "Content-Type: application/json" \  -d '{    "alias": "string"  }'
{
  "templateID": "string",
  "buildID": "string",
  "cpuCount": 1,
  "memoryMB": 128,
  "diskSizeMB": 0,
  "public": true,
  "aliases": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdBy": null,
  "lastSpawnedAt": "2019-08-24T14:15:22Z",
  "spawnCount": 0,
  "buildCount": 0,
  "envdVersion": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/{templateID}/files/{hash}

GET
/templates/{templateID}/files/{hash}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

templateID*string
hash*string

Hash of the files

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/templates/string/files/string"
{
  "present": true,
  "url": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates

GET
/templates

Authorization

X-API-Key<token>

In: header

Query Parameters

teamID?string

Identifier of the team

Response Body

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/templates"
[
  null
]
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates

POST
/templates

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

body*unknown

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.vibengine.app/templates" \  -H "Content-Type: application/json" \  -d '{    "dockerfile": "string"  }'
{
  "templateID": "string",
  "buildID": "string",
  "cpuCount": 1,
  "memoryMB": 128,
  "diskSizeMB": 0,
  "public": true,
  "aliases": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdBy": null,
  "lastSpawnedAt": "2019-08-24T14:15:22Z",
  "spawnCount": 0,
  "buildCount": 0,
  "envdVersion": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/{templateID}

GET
/templates/{templateID}

Authorization

X-API-Key<token>

In: header

Path Parameters

templateID*string

Query Parameters

nextToken?string

Cursor to start the list from

limit?integer

Maximum number of items to return per page

Default100
Formatint32
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/templates/string"
{
  "templateID": "string",
  "public": true,
  "aliases": [
    "string"
  ],
  "names": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "lastSpawnedAt": "2019-08-24T14:15:22Z",
  "spawnCount": 0,
  "builds": [
    {
      "buildID": "9abc211d-7cca-4fea-818a-9faf1e5c8219",
      "status": "building",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "cpuCount": 1,
      "memoryMB": 128,
      "diskSizeMB": 0,
      "envdVersion": "string"
    }
  ]
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/{templateID}

POST
/templates/{templateID}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

templateID*string

Request Body

application/json

body*unknown

Response Body

application/json

application/json

application/json

curl -X POST "https://api.vibengine.app/templates/string" \  -H "Content-Type: application/json" \  -d '{    "dockerfile": "string"  }'
{
  "templateID": "string",
  "buildID": "string",
  "cpuCount": 1,
  "memoryMB": 128,
  "diskSizeMB": 0,
  "public": true,
  "aliases": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdBy": null,
  "lastSpawnedAt": "2019-08-24T14:15:22Z",
  "spawnCount": 0,
  "buildCount": 0,
  "envdVersion": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/{templateID}

PATCH
/templates/{templateID}

Authorization

X-API-Key<token>

In: header

Path Parameters

templateID*string

Request Body

application/json

body*unknown

Response Body

application/json

application/json

application/json

curl -X PATCH "https://api.vibengine.app/templates/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/{templateID}

DELETE
/templates/{templateID}

Authorization

X-API-Key<token>

In: header

Path Parameters

templateID*string

Response Body

application/json

application/json

curl -X DELETE "https://api.vibengine.app/templates/string"
Empty
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/{templateID}/builds/{buildID}

POST
/templates/{templateID}/builds/{buildID}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

templateID*string
buildID*string

Response Body

application/json

application/json

curl -X POST "https://api.vibengine.app/templates/string/builds/string"
Empty
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/v2/templates/{templateID}/builds/{buildID}

POST
/v2/templates/{templateID}/builds/{buildID}

Authorization

X-API-Key<token>

In: header

Path Parameters

templateID*string
buildID*string

Request Body

application/json

fromImage?string

Image to use as a base for the template build

fromTemplate?string

Template to use as a base for the template build

fromImageRegistry?||
force?boolean

Whether the whole build should be forced to run regardless of the cache

Defaultfalse
steps?array<>

List of steps to execute in the template build

Default[]
startCmd?string

Start command to execute in the template after the build

readyCmd?string

Ready check command to execute in the template after the build

Response Body

application/json

application/json

curl -X POST "https://api.vibengine.app/v2/templates/string/builds/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/v2/templates/{templateID}

PATCH
/v2/templates/{templateID}

Authorization

X-API-Key<token>

In: header

Path Parameters

templateID*string

Request Body

application/json

body*unknown

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.vibengine.app/v2/templates/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "names": [
    "string"
  ]
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/{templateID}/builds/{buildID}/status

GET
/templates/{templateID}/builds/{buildID}/status

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

templateID*string
buildID*string

Query Parameters

logsOffset?integer

Index of the starting build log that should be returned with the template

Default0
Formatint32
Range0 <= value
limit?integer

Maximum number of logs that should be returned

Default100
Formatint32
Range0 <= value <= 100
level?string

State of the sandbox

Value in"debug" | "info" | "warn" | "error"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/templates/string/builds/string/status"
{
  "logs": [],
  "logEntries": [],
  "templateID": "string",
  "buildID": "string",
  "status": "building",
  "reason": {
    "message": "string",
    "step": "string",
    "logEntries": []
  }
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/{templateID}/builds/{buildID}/logs

GET
/templates/{templateID}/builds/{buildID}/logs

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

templateID*string
buildID*string

Query Parameters

cursor?integer

Starting timestamp of the logs that should be returned in milliseconds

Formatint64
Range0 <= value
limit?integer

Maximum number of logs that should be returned

Default100
Formatint32
Range0 <= value <= 100
direction?string

Direction of the logs that should be returned

Value in"forward" | "backward"
level?string

State of the sandbox

Value in"debug" | "info" | "warn" | "error"
source?string

Source of the logs that should be returned from

Value in"temporary" | "persistent"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/templates/string/builds/string/logs"
{
  "logs": []
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/templates/aliases/{alias}

GET
/templates/aliases/{alias}

Authorization

X-API-Key<token>

In: header

Path Parameters

alias*string

Template alias

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/templates/aliases/string"
{
  "templateID": "string",
  "public": true
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

Sandboxes

Previous Page

Tags

Next Page