Update Web Box - Continuous

Update Web Box

curl --request PATCH \
  --url https://api.continuouslabs.ai/v1/webbox/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": "<unknown>",
  "name": "<string>"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.continuouslabs.ai/v1/webbox/{id}"

	payload := strings.NewReader("{\n  \"metadata\": \"<unknown>\",\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

import requests

url = "https://api.continuouslabs.ai/v1/webbox/{id}"

payload = {
    "metadata": "<unknown>",
    "name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({metadata: '<unknown>', name: '<string>'})
};

fetch('https://api.continuouslabs.ai/v1/webbox/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "created_at": "2023-11-07T05:31:56Z",
  "error": {
    "agent_message": "<string>",
    "code": "build_failed",
    "detail": "<string>",
    "reason": "canceled",
    "validation": {
      "issues": [
        {
          "code": "<string>",
          "kind": "invalid",
          "location": "<string>",
          "message": "<string>",
          "operation": "<string>",
          "suggestion": "<string>"
        }
      ]
    }
  },
  "id": "<string>",
  "include_sample_data": true,
  "metadata": "<unknown>",
  "name": "<string>",
  "snapshot_id": "<string>",
  "status": "starting",
  "url": "<string>"
}

PATCH

https://api.continuouslabs.ai

/

v1

/

webbox

/

{id}

Update Web Box

curl --request PATCH \
  --url https://api.continuouslabs.ai/v1/webbox/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": "<unknown>",
  "name": "<string>"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.continuouslabs.ai/v1/webbox/{id}"

	payload := strings.NewReader("{\n  \"metadata\": \"<unknown>\",\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

import requests

url = "https://api.continuouslabs.ai/v1/webbox/{id}"

payload = {
    "metadata": "<unknown>",
    "name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({metadata: '<unknown>', name: '<string>'})
};

fetch('https://api.continuouslabs.ai/v1/webbox/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "created_at": "2023-11-07T05:31:56Z",
  "error": {
    "agent_message": "<string>",
    "code": "build_failed",
    "detail": "<string>",
    "reason": "canceled",
    "validation": {
      "issues": [
        {
          "code": "<string>",
          "kind": "invalid",
          "location": "<string>",
          "message": "<string>",
          "operation": "<string>",
          "suggestion": "<string>"
        }
      ]
    }
  },
  "id": "<string>",
  "include_sample_data": true,
  "metadata": "<unknown>",
  "name": "<string>",
  "snapshot_id": "<string>",
  "status": "starting",
  "url": "<string>"
}

Authorizations

Authorization

string

header

required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Path Parameters

id

string

required

Web Box ID.

Pattern: ^wbx_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

metadata

any

Replacement customer JSON metadata, up to 16 KiB and 64 nesting levels, or null to clear it.

name

string

New Web Box name.

Required string length: 1 - 128

Response

OK

created_at

string<date-time>

required

Web Box creation time.

error

object | null

required

Why its last run stopped without a stop request, or null.

Show child attributes

id

string

required

Web Box ID.

Pattern: ^wbx_[0-9A-HJKMNP-TV-Z]{26}$

include_sample_data

boolean

required

Whether the Web Box started with the Snapshot's sample data.

metadata

any

required

Customer JSON metadata, or null.

name

string

required

Web Box name. The ID is its identity, and names need not be unique.

Maximum string length: 128

snapshot_id

string

required

The Web Box Snapshot it started from.

Pattern: ^wbs_[0-9A-HJKMNP-TV-Z]{26}$

status

enum<string>

required

starting while its runtime boots; running while it serves its app; stopping while it saves its state; stopped when it holds no runtime. A start resumes the saved state.

Available options:

starting,

running,

stopping,

stopped

url

string

required

URL that opens the Web Box's app, at a host of its own.