Pages

Host static websites. Create a page, deploy uploaded files to a CDN URL, and set or buy a custom domain.

POST/v1/pages

https://api.vee3.io/v1/pages

200 tokens

Create a static website with a CDN URL.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.create

Parameters2 fields

slugstringRequired

Page slug used for the public hostname ({slug}.vee3.site). Must be unique across Vee3. Lowercase alphanumeric characters and hyphens only; 1-48 characters; must start and end with an alphanumeric character.

max length 48

namestringOptional

Optional display name for the page. Does not change the public URL. At most 80 characters.

max length 80

Response8 fields

page_idstring

Unique identifier for the page.

namestring

Display name for the page, if set.

slugstring

Page slug.

statusstring

Current page status.

urlstring

Public HTTPS URL for the page (https://{slug}.vee3.site until a custom domain is attached).

hostnamestring

Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.

custom_domainstring

Custom hostname attached to the page, if any.

created_atstring

When the page was created.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, pages_not_configured, pages_upstream_error, page_slug_taken

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "slug": "docs",
    "name": "Docs"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created page.

page_created.json

{
  "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Docs",
  "slug": "docs",
  "status": "active",
  "url": "https://docs.vee3.site",
  "hostname": "docs.vee3.site",
  "custom_domain": null,
  "created_at": "2026-08-11T12:00:00.000Z"
}

POST/v1/pages/{page_id}/deploy

https://api.vee3.io/v1/pages/{page_id}/deploy

100 tokens

Deploy previously uploaded files to a hosted static website.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.deploy

Parameters2 fields

page_idstringRequired

Page id returned by pages.create.

filesarrayRequired

Files to deploy. Each item is an object with file_name (uploaded account-relative path) and optional path (destination path on the page; defaults to the file basename). Maximum 500 files.

min 1, max 500

Response4 fields

page_idstring

Page id.

urlstring

Live CDN URL for the page. Uses the custom domain when one is attached.

deployed_file_countinteger

Number of files deployed in this request.

deployed_atstring

When this deploy completed.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, pages_not_configured, pages_upstream_error, page_not_found, uploaded_file_not_found

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages/{page_id}/deploy"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "files": [{"file_name":"sites/docs/index.html","path":"index.html"}]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful deploy response.

deploy_completed.json

{
  "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "url": "https://v3a1b2c3d4e5f678.b-cdn.net",
  "deployed_file_count": 1,
  "deployed_at": "2026-08-11T12:05:00.000Z"
}

GET/v1/pages

https://api.vee3.io/v1/pages

10 tokens

List static websites hosted through this Vee3 account.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.list

Parameters2 fields

limitintegerOptional

Maximum number of pages to return.

Default: 50 · min 1, max 100

pageintegerOptional

Page number for paginated results.

Default: 1 · min 1

Response14 fields

pagesarrayitems

9 fields

Pages for this Vee3 account.

page_idstring

Unique identifier for the page.

namestring

Display name for the page, if set.

slugstring

Page slug.

statusstring

Current page status.

urlstring

Public HTTPS URL for the page. Uses the custom domain when one is attached.

hostnamestring

Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.

custom_domainstring

Custom hostname attached to the page, if any.

created_atstring

When the page was created.

last_deployed_atstring

When files were last deployed to the page.

pagingobject

3 fields

Pagination metadata for the result set.

total_itemsinteger

Total pages matching the query.

current_pageinteger

Current page number.

page_sizeinteger

Number of pages returned per page.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, pages_not_configured, pages_upstream_error

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 50,
    "page": 1
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sample page list response.

pages_page.json

{
  "pages": [
    {
      "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Docs",
      "slug": "docs",
      "status": "active",
      "url": "https://docs.vee3.site",
      "hostname": "docs.vee3.site",
      "custom_domain": null,
      "created_at": "2026-08-11T12:00:00.000Z",
      "last_deployed_at": "2026-08-11T12:05:00.000Z"
    }
  ],
  "paging": {
    "total_items": 1,
    "current_page": 1,
    "page_size": 50
  }
}

GET/v1/pages/{page_id}

https://api.vee3.io/v1/pages/{page_id}

5 tokens

Retrieve details for one static website hosted through this Vee3 account.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.get

Parameters1 field

page_idstringRequired

Page id to look up.

Response10 fields

page_idstring

Unique identifier for the page.

namestring

Display name for the page, if set.

slugstring

Page slug.

statusstring

Current page status.

urlstring

Public HTTPS URL for the page. Uses the custom domain when one is attached.

hostnamestring

Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.

custom_domainstring

Custom hostname attached to the page, if any.

created_atstring

When the page was created.

updated_atstring

When the page record was last updated.

last_deployed_atstring

When files were last deployed to the page.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, pages_not_configured, pages_upstream_error, page_not_found

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages/{page_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sample page details.

page_details.json

{
  "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Docs",
  "slug": "docs",
  "status": "active",
  "url": "https://docs.vee3.site",
  "hostname": "docs.vee3.site",
  "custom_domain": null,
  "created_at": "2026-08-11T12:00:00.000Z",
  "updated_at": "2026-08-11T12:05:00.000Z",
  "last_deployed_at": "2026-08-11T12:05:00.000Z"
}

PATCH/v1/pages/{page_id}

https://api.vee3.io/v1/pages/{page_id}

20 tokens

Update the display name and public slug for a hosted static website.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.edit

Parameters3 fields

page_idstringRequired

Page id to update.

namestringOptional

Display name for the page. Does not change the public URL. Pass an empty value to clear the name. At most 80 characters.

max length 80

slugstringOptional

New page slug used for the public hostname ({slug}.vee3.site). Must be unique across Vee3. Lowercase alphanumeric characters and hyphens only; 1-48 characters; must start and end with an alphanumeric character.

max length 48

Response10 fields

page_idstring

Unique identifier for the page.

namestring

Display name for the page, if set.

slugstring

Page slug.

statusstring

Current page status.

urlstring

Public HTTPS URL for the page. Uses the custom domain when one is attached.

hostnamestring

Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.

custom_domainstring

Custom hostname attached to the page, if any.

created_atstring

When the page was created.

updated_atstring

When the page record was last updated.

last_deployed_atstring

When files were last deployed to the page.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, pages_not_configured, pages_upstream_error, page_not_found, page_slug_taken

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages/{page_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Docs"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Updated page details.

page_updated.json

{
  "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Docs",
  "slug": "help",
  "status": "active",
  "url": "https://help.vee3.site",
  "hostname": "help.vee3.site",
  "custom_domain": null,
  "created_at": "2026-08-11T12:00:00.000Z",
  "updated_at": "2026-08-16T14:40:00.000Z",
  "last_deployed_at": "2026-08-11T12:05:00.000Z"
}

POST/v1/pages/{page_id}/custom-domain

https://api.vee3.io/v1/pages/{page_id}/custom-domain

50 tokens

Attach a custom hostname on a managed Vee3 domain to a hosted static website.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.set_custom_domain

Parameters2 fields

page_idstringRequired

Page id to attach the custom domain to.

custom_domainstringRequired

Hostname to attach, such as www.example.com or example.com. Must be on a domain this Vee3 account already manages. At most 253 characters.

max length 253

Response11 fields

page_idstring

Unique identifier for the page.

namestring

Display name for the page, if set.

slugstring

Page slug.

statusstring

Current page status.

urlstring

Public HTTPS URL for the page. Uses the custom domain when one is attached.

hostnamestring

Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.

custom_domainstring

Custom hostname attached to the page, if any.

messagestring

Note that DNS and TLS can take several minutes to become available, and sometimes up to about 30 minutes.

created_atstring

When the page was created.

updated_atstring

When the page record was last updated.

last_deployed_atstring

When files were last deployed to the page.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, page_not_found, page_custom_domain_not_managed, page_custom_domain_taken, page_custom_domain_not_allowed, dns_not_using_namecheap

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages/{page_id}/custom-domain"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "custom_domain": "www.example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Page details after attaching a custom domain.

custom_domain_attached.json

{
  "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Docs",
  "slug": "docs",
  "status": "active",
  "url": "https://www.example.com",
  "hostname": "docs.vee3.site",
  "custom_domain": "www.example.com",
  "created_at": "2026-08-11T12:00:00.000Z",
  "updated_at": "2026-08-31T14:40:00.000Z",
  "last_deployed_at": "2026-08-11T12:05:00.000Z",
  "message": "The custom domain is attached. DNS and TLS can take several minutes to become available, and sometimes up to about 30 minutes."
}

DELETE/v1/pages/{page_id}/custom-domain

https://api.vee3.io/v1/pages/{page_id}/custom-domain

5 tokens

Detach the custom hostname from a hosted static website.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.remove_custom_domain

Parameters1 field

page_idstringRequired

Page id to detach the custom domain from.

Response10 fields

page_idstring

Unique identifier for the page.

namestring

Display name for the page, if set.

slugstring

Page slug.

statusstring

Current page status.

urlstring

Public HTTPS URL for the page. Uses the custom domain when one is attached.

hostnamestring

Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.

custom_domainstring

Custom hostname attached to the page, if any.

created_atstring

When the page was created.

updated_atstring

When the page record was last updated.

last_deployed_atstring

When files were last deployed to the page.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, page_not_found

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages/{page_id}/custom-domain"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Page details after removing a custom domain.

custom_domain_removed.json

{
  "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Docs",
  "slug": "docs",
  "status": "active",
  "url": "https://docs.vee3.site",
  "hostname": "docs.vee3.site",
  "custom_domain": null,
  "created_at": "2026-08-11T12:00:00.000Z",
  "updated_at": "2026-08-31T14:45:00.000Z",
  "last_deployed_at": "2026-08-11T12:05:00.000Z"
}

DELETE/v1/pages/{page_id}

https://api.vee3.io/v1/pages/{page_id}

5 tokens

Delete a static website hosted through this Vee3 account.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.delete

Parameters1 field

page_idstringRequired

Page id to delete.

Response2 fields

deletedboolean

Whether the page was deleted.

page_idstring

Deleted page id.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, pages_not_configured, pages_upstream_error, page_not_found

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages/{page_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful delete response.

page_deleted.json

{
  "deleted": true,
  "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}