Create a static site
curl --request POST \
--url https://app.miget.com/api/v1/static \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"name": "<string>",
"deployment_config": {
"credential_id": "<string>",
"repository": "<string>",
"branch": "<string>",
"auto_deploy_enabled": true,
"auto_deploy_branch": "<string>",
"generator": "<string>",
"build_command": "<string>",
"output_dir": "<string>",
"project_path": "<string>",
"spa_mode": true
},
"project_id": "<string>",
"new_project_name": "<string>",
"new_project_description": "<string>",
"region": "eu-east-1",
"app_vars_attributes": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://app.miget.com/api/v1/static"
payload = {
"label": "<string>",
"name": "<string>",
"deployment_config": {
"credential_id": "<string>",
"repository": "<string>",
"branch": "<string>",
"auto_deploy_enabled": True,
"auto_deploy_branch": "<string>",
"generator": "<string>",
"build_command": "<string>",
"output_dir": "<string>",
"project_path": "<string>",
"spa_mode": True
},
"project_id": "<string>",
"new_project_name": "<string>",
"new_project_description": "<string>",
"region": "eu-east-1",
"app_vars_attributes": [
{
"key": "<string>",
"value": "<string>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
name: '<string>',
deployment_config: {
credential_id: '<string>',
repository: '<string>',
branch: '<string>',
auto_deploy_enabled: true,
auto_deploy_branch: '<string>',
generator: '<string>',
build_command: '<string>',
output_dir: '<string>',
project_path: '<string>',
spa_mode: true
},
project_id: '<string>',
new_project_name: '<string>',
new_project_description: '<string>',
region: 'eu-east-1',
app_vars_attributes: [{key: '<string>', value: '<string>'}]
})
};
fetch('https://app.miget.com/api/v1/static', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.miget.com/api/v1/static",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'name' => '<string>',
'deployment_config' => [
'credential_id' => '<string>',
'repository' => '<string>',
'branch' => '<string>',
'auto_deploy_enabled' => true,
'auto_deploy_branch' => '<string>',
'generator' => '<string>',
'build_command' => '<string>',
'output_dir' => '<string>',
'project_path' => '<string>',
'spa_mode' => true
],
'project_id' => '<string>',
'new_project_name' => '<string>',
'new_project_description' => '<string>',
'region' => 'eu-east-1',
'app_vars_attributes' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.miget.com/api/v1/static"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"repository\": \"<string>\",\n \"branch\": \"<string>\",\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"generator\": \"<string>\",\n \"build_command\": \"<string>\",\n \"output_dir\": \"<string>\",\n \"project_path\": \"<string>\",\n \"spa_mode\": true\n },\n \"project_id\": \"<string>\",\n \"new_project_name\": \"<string>\",\n \"new_project_description\": \"<string>\",\n \"region\": \"eu-east-1\",\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://app.miget.com/api/v1/static")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"repository\": \"<string>\",\n \"branch\": \"<string>\",\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"generator\": \"<string>\",\n \"build_command\": \"<string>\",\n \"output_dir\": \"<string>\",\n \"project_path\": \"<string>\",\n \"spa_mode\": true\n },\n \"project_id\": \"<string>\",\n \"new_project_name\": \"<string>\",\n \"new_project_description\": \"<string>\",\n \"region\": \"eu-east-1\",\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.miget.com/api/v1/static")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"repository\": \"<string>\",\n \"branch\": \"<string>\",\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"generator\": \"<string>\",\n \"build_command\": \"<string>\",\n \"output_dir\": \"<string>\",\n \"project_path\": \"<string>\",\n \"spa_mode\": true\n },\n \"project_id\": \"<string>\",\n \"new_project_name\": \"<string>\",\n \"new_project_description\": \"<string>\",\n \"region\": \"eu-east-1\",\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"label": "<string>",
"state": "<string>",
"url": "<string>",
"region": "<string>",
"project_id": "<string>",
"deployment_config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Static Sites
Create a static site
Creates a static site served from object storage. There is no compute resource to assign: the name you send is the name the site is served under, with no random suffix, and it must be unique across the platform. The content source is fixed at creation - create another site to use a different one.
POST
/
api
/
v1
/
static
Create a static site
curl --request POST \
--url https://app.miget.com/api/v1/static \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"name": "<string>",
"deployment_config": {
"credential_id": "<string>",
"repository": "<string>",
"branch": "<string>",
"auto_deploy_enabled": true,
"auto_deploy_branch": "<string>",
"generator": "<string>",
"build_command": "<string>",
"output_dir": "<string>",
"project_path": "<string>",
"spa_mode": true
},
"project_id": "<string>",
"new_project_name": "<string>",
"new_project_description": "<string>",
"region": "eu-east-1",
"app_vars_attributes": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://app.miget.com/api/v1/static"
payload = {
"label": "<string>",
"name": "<string>",
"deployment_config": {
"credential_id": "<string>",
"repository": "<string>",
"branch": "<string>",
"auto_deploy_enabled": True,
"auto_deploy_branch": "<string>",
"generator": "<string>",
"build_command": "<string>",
"output_dir": "<string>",
"project_path": "<string>",
"spa_mode": True
},
"project_id": "<string>",
"new_project_name": "<string>",
"new_project_description": "<string>",
"region": "eu-east-1",
"app_vars_attributes": [
{
"key": "<string>",
"value": "<string>"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
name: '<string>',
deployment_config: {
credential_id: '<string>',
repository: '<string>',
branch: '<string>',
auto_deploy_enabled: true,
auto_deploy_branch: '<string>',
generator: '<string>',
build_command: '<string>',
output_dir: '<string>',
project_path: '<string>',
spa_mode: true
},
project_id: '<string>',
new_project_name: '<string>',
new_project_description: '<string>',
region: 'eu-east-1',
app_vars_attributes: [{key: '<string>', value: '<string>'}]
})
};
fetch('https://app.miget.com/api/v1/static', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.miget.com/api/v1/static",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'name' => '<string>',
'deployment_config' => [
'credential_id' => '<string>',
'repository' => '<string>',
'branch' => '<string>',
'auto_deploy_enabled' => true,
'auto_deploy_branch' => '<string>',
'generator' => '<string>',
'build_command' => '<string>',
'output_dir' => '<string>',
'project_path' => '<string>',
'spa_mode' => true
],
'project_id' => '<string>',
'new_project_name' => '<string>',
'new_project_description' => '<string>',
'region' => 'eu-east-1',
'app_vars_attributes' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.miget.com/api/v1/static"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"repository\": \"<string>\",\n \"branch\": \"<string>\",\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"generator\": \"<string>\",\n \"build_command\": \"<string>\",\n \"output_dir\": \"<string>\",\n \"project_path\": \"<string>\",\n \"spa_mode\": true\n },\n \"project_id\": \"<string>\",\n \"new_project_name\": \"<string>\",\n \"new_project_description\": \"<string>\",\n \"region\": \"eu-east-1\",\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://app.miget.com/api/v1/static")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"repository\": \"<string>\",\n \"branch\": \"<string>\",\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"generator\": \"<string>\",\n \"build_command\": \"<string>\",\n \"output_dir\": \"<string>\",\n \"project_path\": \"<string>\",\n \"spa_mode\": true\n },\n \"project_id\": \"<string>\",\n \"new_project_name\": \"<string>\",\n \"new_project_description\": \"<string>\",\n \"region\": \"eu-east-1\",\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.miget.com/api/v1/static")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"repository\": \"<string>\",\n \"branch\": \"<string>\",\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"generator\": \"<string>\",\n \"build_command\": \"<string>\",\n \"output_dir\": \"<string>\",\n \"project_path\": \"<string>\",\n \"spa_mode\": true\n },\n \"project_id\": \"<string>\",\n \"new_project_name\": \"<string>\",\n \"new_project_description\": \"<string>\",\n \"region\": \"eu-east-1\",\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"label": "<string>",
"state": "<string>",
"url": "<string>",
"region": "<string>",
"project_id": "<string>",
"deployment_config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
Bearer token for authentication. Format: 'Bearer {token}'
Headers
Workspace ID (uses default workspace if not provided)
Body
application/json
Create a static site
Human-readable display name
The name the site is served under (lowercase, alphanumeric with hyphens). Unlike applications no suffix is appended, so it must be unique across the platform
Content source and build configuration
Show child attributes
Show child attributes
UUID of the project to create the site in. Omit it and supply new_project_name to create one
Create a new project with this name instead of using project_id
Description for the project created via new_project_name
Region the content is stored in (defaults to 'eu-east-1'; currently the only supported region). Serving is region-less
Available options:
eu-east-1 Build-time environment variables, exposed to the build as BUILD_VAR_*
Show child attributes
Show child attributes
Response
Create a static site
Api_V1_Entities_StaticSite model
Unique static site identifier
The name the site is served under. Unlike applications, no random suffix is appended, so it is the name you sent at creation
Display name
Current state: pending while the bucket and routing are provisioned, assigned once ready, deploying during a deploy, running when live, failed on error
Public URL the site is served on. Custom domains are listed separately
Region the content is stored in. Serving is region-less
Associated project UUID
Content source and build configuration. Bucket credentials are never exposed
Creation timestamp
Last update timestamp
⌘I