Vibengine
API Reference

Sandboxes

/sandboxes

GET
/sandboxes

Authorization

X-API-Key<token>

In: header

Query Parameters

metadata?string

Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded.

Response Body

application/json

application/json

application/json

application/json

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

/sandboxes

POST
/sandboxes

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/sandboxes" \  -H "Content-Type: application/json" \  -d '{    "templateID": "string"  }'
{
  "templateID": "string",
  "sandboxID": "string",
  "alias": "string",
  "clientID": "string",
  "envdVersion": "string",
  "envdAccessToken": "string",
  "trafficAccessToken": "string",
  "domain": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/v2/sandboxes

GET
/v2/sandboxes

Authorization

X-API-Key<token>

In: header

Query Parameters

metadata?string

Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded.

state?array<>

Filter sandboxes by one or more states

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

application/json

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

/sandboxes/metrics

GET
/sandboxes/metrics

Authorization

X-API-Key<token>

In: header

Query Parameters

sandbox_ids*array<>

Comma-separated list of sandbox IDs to get metrics for

Itemsitems <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/sandboxes/metrics?sandbox_ids=string"
{
  "sandboxes": {
    "property1": {
      "timestamp": "2019-08-24T14:15:22Z",
      "timestampUnix": 0,
      "cpuCount": 0,
      "cpuUsedPct": 0.1,
      "memUsed": 0,
      "memTotal": 0,
      "diskUsed": 0,
      "diskTotal": 0
    },
    "property2": {
      "timestamp": "2019-08-24T14:15:22Z",
      "timestampUnix": 0,
      "cpuCount": 0,
      "cpuUsedPct": 0.1,
      "memUsed": 0,
      "memTotal": 0,
      "diskUsed": 0,
      "diskTotal": 0
    }
  }
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/sandboxes/{sandboxID}/logs

GET
/sandboxes/{sandboxID}/logs

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Query Parameters

start?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

Default1000
Formatint32
Range0 <= value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/sandboxes/string/logs"
{
  "logs": [
    {
      "timestamp": "2019-08-24T14:15:22Z",
      "line": "string"
    }
  ],
  "logEntries": [
    {
      "timestamp": "2019-08-24T14:15:22Z",
      "message": "string",
      "level": "debug",
      "fields": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/v2/sandboxes/{sandboxID}/logs

GET
/v2/sandboxes/{sandboxID}/logs

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*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

Default1000
Formatint32
Range0 <= value <= 1000
direction?string

Direction of the logs that should be returned

Value in"forward" | "backward"

Response Body

application/json

application/json

application/json

application/json

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

/sandboxes/{sandboxID}

GET
/sandboxes/{sandboxID}

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/sandboxes/string"
{
  "templateID": "string",
  "alias": "string",
  "sandboxID": "string",
  "clientID": "string",
  "startedAt": "2019-08-24T14:15:22Z",
  "endAt": "2019-08-24T14:15:22Z",
  "envdVersion": "string",
  "envdAccessToken": "string",
  "domain": "string",
  "cpuCount": 1,
  "memoryMB": 128,
  "diskSizeMB": 0,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "state": "running"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/sandboxes/{sandboxID}

DELETE
/sandboxes/{sandboxID}

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Response Body

application/json

application/json

application/json

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

/sandboxes/{sandboxID}/metrics

GET
/sandboxes/{sandboxID}/metrics

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Query Parameters

start?integer

Unix timestamp for the start of the interval, in seconds, for which the metrics

Formatint64
Range0 <= value
end?integer

Unix timestamp for the end of the interval, in seconds, for which the metrics

Formatint64
Range0 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vibengine.app/sandboxes/string/metrics"
[
  {
    "timestamp": "2019-08-24T14:15:22Z",
    "timestampUnix": 0,
    "cpuCount": 0,
    "cpuUsedPct": 0.1,
    "memUsed": 0,
    "memTotal": 0,
    "diskUsed": 0,
    "diskTotal": 0
  }
]
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/sandboxes/{sandboxID}/pause

POST
/sandboxes/{sandboxID}/pause

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Response Body

application/json

application/json

application/json

application/json

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

/sandboxes/{sandboxID}/resume

POST
/sandboxes/{sandboxID}/resume

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Request Body

application/json

body*unknown

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.vibengine.app/sandboxes/string/resume" \  -H "Content-Type: application/json" \  -d '{}'
{
  "templateID": "string",
  "sandboxID": "string",
  "alias": "string",
  "clientID": "string",
  "envdVersion": "string",
  "envdAccessToken": "string",
  "trafficAccessToken": "string",
  "domain": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/sandboxes/{sandboxID}/connect

POST
/sandboxes/{sandboxID}/connect

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Request Body

application/json

timeout*integer

Timeout in seconds from the current time after which the sandbox should expire

Formatint32
Range0 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.vibengine.app/sandboxes/string/connect" \  -H "Content-Type: application/json" \  -d '{    "timeout": 0  }'
{
  "templateID": "string",
  "sandboxID": "string",
  "alias": "string",
  "clientID": "string",
  "envdVersion": "string",
  "envdAccessToken": "string",
  "trafficAccessToken": "string",
  "domain": "string"
}
{
  "templateID": "string",
  "sandboxID": "string",
  "alias": "string",
  "clientID": "string",
  "envdVersion": "string",
  "envdAccessToken": "string",
  "trafficAccessToken": "string",
  "domain": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}
{
  "code": 0,
  "message": "string"
}

/sandboxes/{sandboxID}/timeout

POST
/sandboxes/{sandboxID}/timeout

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Request Body

application/json

timeout*integer

Timeout in seconds from the current time after which the sandbox should expire

Formatint32
Range0 <= value

Response Body

application/json

application/json

application/json

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

/sandboxes/{sandboxID}/refreshes

POST
/sandboxes/{sandboxID}/refreshes

Authorization

X-API-Key<token>

In: header

Path Parameters

sandboxID*string

Request Body

application/json

duration?integer

Duration for which the sandbox should be kept alive in seconds

Range0 <= value <= 3600

Response Body

application/json

application/json

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

API Reference

Vibengine REST API documentation

Templates

Next Page