logo

Static Sites

This section will contain a more detailed description soon. For the time being, you can feel free to rely on the auto-generated information to get started!

Get list of company static sites

SecuritybearerAuth
Request
query Parameters
company
required
string
Example: company=54fb80af-576c-4fdc-ba4f-b596c83f15a1
limit
number
Default: 10
Example: limit=10
offset
number
Default: 0
Example: offset=3
Responses
200

Successfully found static sites

401

No or invalid API key provided to the request

404

Could not find the static sites or the user does not have permissions to retrieve data

500

Error occurred while retrieving static sites

get/static-sites
Request samples 
Response samples 
application/json
{
  • "company": {
    }
}
Get static site by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
 
 Example:  54fb80af-576c-4fdc-ba4f-b596c83f15a1
Responses 
200
Successfully found static site


401
No or invalid API key provided to the request


404
Could not find the static site or the user does not have permissions to retrieve data


500
Error occurred while retrieving static site by ID


get/static-sites/{id}
Request samples 
Response samples 
application/json
{
  • "static_site": {
    }
}
Update static site basic details
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
 
 Example:  54fb80af-576c-4fdc-ba4f-b596c83f15a1
Request Body schema: application/json
required
display_name
string
 
auto_deploy
boolean
 
default_branch
string
 
build_command
string or null
 
node_version
string or null
 Enum: "16.20.0" "18.16.0" "20.2.0"  
published_directory
string or null
 
Responses 
200
Static site updated successfully


401
No or invalid API key provided to the request


500
Error occurred while updating static site


put/static-sites/{id}
Request samples 
application/json
{
  • "display_name": "My static site",
  • "auto_deploy": true,
  • "default_branch": "main",
  • "build_command": "npm run build",
  • "node_version": "18.16.0",
  • "published_directory": "dist"
}
Response samples 
application/json
{
  • "static_site": {
    }
}
Delete static site
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
 
 Example:  54fb80af-576c-4fdc-ba4f-b596c83f15a1
Responses 
200
Response object of static site requests


401
No or invalid API key provided to the request


404
Could not find the static site or the user does not have required permissions


500
Error occurred while deleting static site


delete/static-sites/{id}
Request samples 
Response samples 
database/json
{
  • "transaction_id": "8097788359944597"
}
➔ Next to Static Site Deployments