Deploy a site

POST

/deploy

curl --request POST \
  --url https://example.com/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file

Upload a ZIP archive as a new deployment. It becomes active immediately. Buzz creates the site if needed. A deployment token may deploy only to its assigned site and must send that name in X-Buzz-Site.

Authorizations

• BearerAuth

Parameters

Header Parameters

x-buzz-site

Any of:

string

string

null

null

Site to deploy to. Buzz generates a name when omitted.

x-buzz-access

Any of:

string

string

null

null

Set to ‘private’ to publish the site and protect it atomically.

Request Body^required

Media typemultipart/form-data

object

file

required

A ZIP archive containing the site’s files.

string format: binary

Responses

200

Successful Response

Media typeapplication/json

DeploySiteResponse

object

deployment_number

required

Deployment Number

integer

name

required

Name

string

private

required

Private

boolean

site_name

required

Site Name

string

url

required

Url

string

Example^generated

{
  "deployment_number": 1,
  "name": "example",
  "private": true,
  "site_name": "example",
  "url": "example"
}

400

The site name or archive is invalid.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

401

Authentication is required.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

403

The credential cannot deploy this site.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

413

A deployment limit was exceeded.

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}