VECTOR

Core Workflows

Common operations you'll perform with Vector Pro after initial setup. Each workflow includes the relevant API calls and important considerations.

Managing Sites

Updating a Site

Update a site's metadata with a PUT request. Only the fields you include will be updated.

curl -X PUT https://api.builtfast.com/api/v1/vector/sites/{site_id} \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "partner_customer_id": "cust_67890",
    "tags": ["wordpress", "enterprise"]
  }'

Updatable fields:

partner_customer_id — Update your internal customer reference
tags — Update categorization tags (pass null to clear)

Suspending a Site

Suspend a site's development container to reduce costs during inactive periods. This scales down the container while preserving all data for quick resumption.

curl -X PUT https://api.builtfast.com/api/v1/vector/sites/{site_id}/suspend \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

While suspended:

The development environment is not accessible
WP Admin and SFTP are unavailable
Deployed environments continue to function normally
All data is preserved

Unsuspending a Site

curl -X PUT https://api.builtfast.com/api/v1/vector/sites/{site_id}/unsuspend \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Deleting a Site

Delete a site permanently. This is irreversible.

curl -X DELETE https://api.builtfast.com/api/v1/vector/sites/{site_id} \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Important

All environments must be deleted before you can delete a site. Delete each environment first, then delete the site.

Managing Environments

Creating a Staging Environment

Most sites need a staging environment for testing before production. Create one with is_production: false:

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "staging",
    "php_version": "8.3",
    "custom_domain": null,
    "is_production": false
  }'

Staging environments:

Run on the same serverless infrastructure as production
Do not include CDN (requests go directly to origin)
Are accessible via the generated subdomain
Can have custom domains attached if needed

Updating an Environment

curl -X PUT https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id} \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_domain": "www.customersite.com",
    "tags": ["live", "primary"]
  }'

Updatable fields:

name — Rename the environment
is_production — Promote to production or demote
custom_domain — Attach or change custom domain
tags — Update categorization tags

Attaching a Custom Domain

When your customer wants to use their own domain:

curl -X PUT https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id} \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_domain": "www.customersite.com"
  }'

After attaching the domain:

Vector Pro provisions an SSL certificate automatically
The customer needs to update their DNS to point to your infrastructure
You can check SSL provisioning status via the SSL endpoint

Checking SSL Status

curl -X GET https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id}/ssl \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

The provisioning_step field tracks progress: requesting_cert → waiting_cert → deploying → configuring_dns → ready → waiting_custom_dns → provisioning_cdn_ssl → complete

Deleting an Environment

curl -X DELETE https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id} \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Deployments

Triggering a Deployment

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id}/deployments \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Monitoring Deployment Status

curl -X GET https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id}/deployments/{deployment_id} \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

If a deployment fails, check the stdout and stderr fields for diagnostic information.

Rolling Back

Roll back to the last successful deployment:

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id}/rollback \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

To roll back to a specific deployment:

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id}/rollback \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "target_deployment_id": "01JFGXK4NQRST5VWX9YZ0ABCDI"
  }'

Cache Management

Production environments include CDN caching. When you need to clear cached content:

Full Cache Purge

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/purge-cache \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Purge by Cache Tag

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/purge-cache \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "cache_tag": "images"
  }'

Purge Specific URL

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/purge-cache \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.customersite.com/style.css"
  }'

SSH Keys

Manage SSH access to development containers.

Adding an SSH Key

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/ssh-keys \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "ssh_key_id": "01JFGXK4NQRST5VWX9YZ0ABCDK"
  }'

Listing Site SSH Keys

curl -X GET https://api.builtfast.com/api/v1/vector/sites/{site_id}/ssh-keys \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Removing an SSH Key

curl -X DELETE https://api.builtfast.com/api/v1/vector/sites/{site_id}/ssh-keys/{ssh_key_id} \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Secrets Management

Store sensitive configuration values that are injected as environment variables during deployment.

Global Secrets

Global secrets are available to all sites in your account:

curl -X POST https://api.builtfast.com/api/v1/vector/global-secrets \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "STRIPE_SECRET_KEY",
    "value": "sk_live_..."
  }'

Environment Secrets

Environment-specific secrets override global secrets:

curl -X POST https://api.builtfast.com/api/v1/vector/sites/{site_id}/environments/{environment_id}/secrets \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "STRIPE_SECRET_KEY",
    "value": "sk_test_..."
  }'

Note

Secret values are never returned in API responses. You can update or delete secrets, but you cannot retrieve the stored value.

Event Logs

View an audit trail of activity in your account:

curl -X GET https://api.builtfast.com/api/v1/vector/events \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Events are retained for 90 days and include site events, environment events, deployment events, CDN and DNS events, SSH key changes, and more.

Quick Reference

Operation	Method	Endpoint
Update site	`PUT`	`/api/v1/vector/sites/{site_id}`
Suspend site	`PUT`	`/api/v1/vector/sites/{site_id}/suspend`
Unsuspend site	`PUT`	`/api/v1/vector/sites/{site_id}/unsuspend`
Delete site	`DELETE`	`/api/v1/vector/sites/{site_id}`
Update environment	`PUT`	`/api/v1/vector/sites/{site_id}/environments/{env_id}`
Delete environment	`DELETE`	`/api/v1/vector/sites/{site_id}/environments/{env_id}`
Get SSL status	`GET`	`/api/v1/vector/sites/{site_id}/environments/{env_id}/ssl`
Create deployment	`POST`	`/api/v1/vector/sites/{site_id}/environments/{env_id}/deployments`
Rollback	`POST`	`/api/v1/vector/sites/{site_id}/environments/{env_id}/rollback`
Purge cache	`POST`	`/api/v1/vector/sites/{site_id}/purge-cache`
List events	`GET`	`/api/v1/vector/events`

Getting Started Next: Webhooks