Set the preview environment config

curl --request PUT \
  --url https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "resource_id": "<string>",
  "project_id": "<string>",
  "trigger_label": "<string>",
  "branch_pattern": "<string>",
  "pr_name_pattern": "<string>",
  "auto_deploy_on_push": true,
  "cleanup_on_pr_merge": true,
  "cleanup_on_pr_close": true,
  "cleanup_on_branch_delete": true,
  "cleanup_on_inactivity": true,
  "inactivity_days": 123,
  "retention_days": 123,
  "comment_on_github": true,
  "clone_settings": {}
}
'

import requests

url = "https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config"

payload = {
    "enabled": True,
    "resource_id": "<string>",
    "project_id": "<string>",
    "trigger_label": "<string>",
    "branch_pattern": "<string>",
    "pr_name_pattern": "<string>",
    "auto_deploy_on_push": True,
    "cleanup_on_pr_merge": True,
    "cleanup_on_pr_close": True,
    "cleanup_on_branch_delete": True,
    "cleanup_on_inactivity": True,
    "inactivity_days": 123,
    "retention_days": 123,
    "comment_on_github": True,
    "clone_settings": {}
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    resource_id: '<string>',
    project_id: '<string>',
    trigger_label: '<string>',
    branch_pattern: '<string>',
    pr_name_pattern: '<string>',
    auto_deploy_on_push: true,
    cleanup_on_pr_merge: true,
    cleanup_on_pr_close: true,
    cleanup_on_branch_delete: true,
    cleanup_on_inactivity: true,
    inactivity_days: 123,
    retention_days: 123,
    comment_on_github: true,
    clone_settings: {}
  })
};

fetch('https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config', 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/apps/{uuid}/preview_environments/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'resource_id' => '<string>',
    'project_id' => '<string>',
    'trigger_label' => '<string>',
    'branch_pattern' => '<string>',
    'pr_name_pattern' => '<string>',
    'auto_deploy_on_push' => true,
    'cleanup_on_pr_merge' => true,
    'cleanup_on_pr_close' => true,
    'cleanup_on_branch_delete' => true,
    'cleanup_on_inactivity' => true,
    'inactivity_days' => 123,
    'retention_days' => 123,
    'comment_on_github' => true,
    'clone_settings' => [
        
    ]
  ]),
  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/apps/{uuid}/preview_environments/config"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"resource_id\": \"<string>\",\n  \"project_id\": \"<string>\",\n  \"trigger_label\": \"<string>\",\n  \"branch_pattern\": \"<string>\",\n  \"pr_name_pattern\": \"<string>\",\n  \"auto_deploy_on_push\": true,\n  \"cleanup_on_pr_merge\": true,\n  \"cleanup_on_pr_close\": true,\n  \"cleanup_on_branch_delete\": true,\n  \"cleanup_on_inactivity\": true,\n  \"inactivity_days\": 123,\n  \"retention_days\": 123,\n  \"comment_on_github\": true,\n  \"clone_settings\": {}\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"resource_id\": \"<string>\",\n  \"project_id\": \"<string>\",\n  \"trigger_label\": \"<string>\",\n  \"branch_pattern\": \"<string>\",\n  \"pr_name_pattern\": \"<string>\",\n  \"auto_deploy_on_push\": true,\n  \"cleanup_on_pr_merge\": true,\n  \"cleanup_on_pr_close\": true,\n  \"cleanup_on_branch_delete\": true,\n  \"cleanup_on_inactivity\": true,\n  \"inactivity_days\": 123,\n  \"retention_days\": 123,\n  \"comment_on_github\": true,\n  \"clone_settings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"resource_id\": \"<string>\",\n  \"project_id\": \"<string>\",\n  \"trigger_label\": \"<string>\",\n  \"branch_pattern\": \"<string>\",\n  \"pr_name_pattern\": \"<string>\",\n  \"auto_deploy_on_push\": true,\n  \"cleanup_on_pr_merge\": true,\n  \"cleanup_on_pr_close\": true,\n  \"cleanup_on_branch_delete\": true,\n  \"cleanup_on_inactivity\": true,\n  \"inactivity_days\": 123,\n  \"retention_days\": 123,\n  \"comment_on_github\": true,\n  \"clone_settings\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "enabled": true,
  "resource_mode": "<string>",
  "resource_id": "<string>",
  "project_id": "<string>",
  "trigger_mode": "<string>",
  "trigger_filter": "<string>",
  "trigger_label": "<string>",
  "branch_pattern": "<string>",
  "pr_name_pattern": "<string>",
  "auto_deploy_on_push": true,
  "cleanup_on_pr_merge": true,
  "cleanup_on_pr_close": true,
  "cleanup_on_branch_delete": true,
  "cleanup_on_inactivity": true,
  "inactivity_days": 123,
  "retention_days": 123,
  "retention_mode": "<string>",
  "comment_on_github": true,
  "clone_settings": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

PUT

api

apps

{uuid}

preview_environments

config

Set the preview environment config

curl --request PUT \
  --url https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "resource_id": "<string>",
  "project_id": "<string>",
  "trigger_label": "<string>",
  "branch_pattern": "<string>",
  "pr_name_pattern": "<string>",
  "auto_deploy_on_push": true,
  "cleanup_on_pr_merge": true,
  "cleanup_on_pr_close": true,
  "cleanup_on_branch_delete": true,
  "cleanup_on_inactivity": true,
  "inactivity_days": 123,
  "retention_days": 123,
  "comment_on_github": true,
  "clone_settings": {}
}
'

import requests

url = "https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config"

payload = {
    "enabled": True,
    "resource_id": "<string>",
    "project_id": "<string>",
    "trigger_label": "<string>",
    "branch_pattern": "<string>",
    "pr_name_pattern": "<string>",
    "auto_deploy_on_push": True,
    "cleanup_on_pr_merge": True,
    "cleanup_on_pr_close": True,
    "cleanup_on_branch_delete": True,
    "cleanup_on_inactivity": True,
    "inactivity_days": 123,
    "retention_days": 123,
    "comment_on_github": True,
    "clone_settings": {}
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    resource_id: '<string>',
    project_id: '<string>',
    trigger_label: '<string>',
    branch_pattern: '<string>',
    pr_name_pattern: '<string>',
    auto_deploy_on_push: true,
    cleanup_on_pr_merge: true,
    cleanup_on_pr_close: true,
    cleanup_on_branch_delete: true,
    cleanup_on_inactivity: true,
    inactivity_days: 123,
    retention_days: 123,
    comment_on_github: true,
    clone_settings: {}
  })
};

fetch('https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config', 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/apps/{uuid}/preview_environments/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'resource_id' => '<string>',
    'project_id' => '<string>',
    'trigger_label' => '<string>',
    'branch_pattern' => '<string>',
    'pr_name_pattern' => '<string>',
    'auto_deploy_on_push' => true,
    'cleanup_on_pr_merge' => true,
    'cleanup_on_pr_close' => true,
    'cleanup_on_branch_delete' => true,
    'cleanup_on_inactivity' => true,
    'inactivity_days' => 123,
    'retention_days' => 123,
    'comment_on_github' => true,
    'clone_settings' => [
        
    ]
  ]),
  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/apps/{uuid}/preview_environments/config"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"resource_id\": \"<string>\",\n  \"project_id\": \"<string>\",\n  \"trigger_label\": \"<string>\",\n  \"branch_pattern\": \"<string>\",\n  \"pr_name_pattern\": \"<string>\",\n  \"auto_deploy_on_push\": true,\n  \"cleanup_on_pr_merge\": true,\n  \"cleanup_on_pr_close\": true,\n  \"cleanup_on_branch_delete\": true,\n  \"cleanup_on_inactivity\": true,\n  \"inactivity_days\": 123,\n  \"retention_days\": 123,\n  \"comment_on_github\": true,\n  \"clone_settings\": {}\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"resource_id\": \"<string>\",\n  \"project_id\": \"<string>\",\n  \"trigger_label\": \"<string>\",\n  \"branch_pattern\": \"<string>\",\n  \"pr_name_pattern\": \"<string>\",\n  \"auto_deploy_on_push\": true,\n  \"cleanup_on_pr_merge\": true,\n  \"cleanup_on_pr_close\": true,\n  \"cleanup_on_branch_delete\": true,\n  \"cleanup_on_inactivity\": true,\n  \"inactivity_days\": 123,\n  \"retention_days\": 123,\n  \"comment_on_github\": true,\n  \"clone_settings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.miget.com/api/v1/apps/{uuid}/preview_environments/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"resource_id\": \"<string>\",\n  \"project_id\": \"<string>\",\n  \"trigger_label\": \"<string>\",\n  \"branch_pattern\": \"<string>\",\n  \"pr_name_pattern\": \"<string>\",\n  \"auto_deploy_on_push\": true,\n  \"cleanup_on_pr_merge\": true,\n  \"cleanup_on_pr_close\": true,\n  \"cleanup_on_branch_delete\": true,\n  \"cleanup_on_inactivity\": true,\n  \"inactivity_days\": 123,\n  \"retention_days\": 123,\n  \"comment_on_github\": true,\n  \"clone_settings\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "enabled": true,
  "resource_mode": "<string>",
  "resource_id": "<string>",
  "project_id": "<string>",
  "trigger_mode": "<string>",
  "trigger_filter": "<string>",
  "trigger_label": "<string>",
  "branch_pattern": "<string>",
  "pr_name_pattern": "<string>",
  "auto_deploy_on_push": true,
  "cleanup_on_pr_merge": true,
  "cleanup_on_pr_close": true,
  "cleanup_on_branch_delete": true,
  "cleanup_on_inactivity": true,
  "inactivity_days": 123,
  "retention_days": 123,
  "retention_mode": "<string>",
  "comment_on_github": true,
  "clone_settings": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id

string

Workspace ID (uses default workspace if not provided)

Path Parameters

uuid

string

required

Application UUID

Body

application/json

Set the preview environment config

enabled

boolean

Create preview environments for this application. Defaults to false

resource_mode

enum<string>

parent reuses the application's resource, existing requires resource_id. Defaults to parent

Available options:

parent,

existing

resource_id

string

UUID of the resource preview environments run on. Required when resource_mode is existing

project_id

string

UUID of the project preview environments land in. Omit to follow the parent application

trigger_mode

enum<string>

pull_request creates one per pull request, every_branch creates one per pushed branch. Defaults to pull_request

Available options:

pull_request,

every_branch

trigger_filter

enum<string>

Which pull requests qualify: auto (all non-draft), label, branch_pattern or pr_name_pattern. Defaults to auto

Available options:

auto,

label,

branch_pattern,

pr_name_pattern

trigger_label

string

Pull request label that triggers creation. Required when trigger_filter is label

branch_pattern

string

Glob matched against the branch name, e.g. feature/*. Required when trigger_filter is branch_pattern

pr_name_pattern

string

Glob matched against the pull request title, e.g. feat:*. Required when trigger_filter is pr_name_pattern

auto_deploy_on_push

boolean

Redeploy on every push to the tracked branch. Defaults to true

cleanup_on_pr_merge

boolean

Destroy when the pull request is merged. Defaults to true

cleanup_on_pr_close

boolean

Destroy when the pull request is closed unmerged. Defaults to false

cleanup_on_branch_delete

boolean

Destroy when the branch is deleted. Defaults to false

cleanup_on_inactivity

boolean

Destroy after inactivity_days without a commit. Defaults to false

inactivity_days

integer<int32>

Days without a commit before cleanup. Defaults to 14

retention_days

integer<int32>

Days a preview environment is kept before it expires. Defaults to 7

retention_mode

enum<string>

after_pr_close counts from the pull request closing, from_creation counts from creation. Defaults to after_pr_close

Available options:

after_pr_close,

from_creation

comment_on_github

boolean

Post the preview environment URL as a pull request comment. Defaults to true, and is forced off in every_branch mode

clone_settings

object

What is copied from the parent application. clone_variables, clone_secret_files and clone_security default to true when absent; addons and cronjobs default to copying all

Response

Set the preview environment config

Api_V1_Entities_PreviewEnvironmentConfig model

enabled

boolean

required

Whether preview environments are created for this application

resource_mode

string

required

parent (reuse the application's resource) or existing (use resource_id)

resource_id

string

required

UUID of the resource preview environments run on, when resource_mode is existing

project_id

string

required

UUID of the project preview environments land in. Null means they follow the parent application

trigger_mode

string

required

pull_request or every_branch

trigger_filter

string

required

auto, label, branch_pattern or pr_name_pattern

trigger_label

string

required

Pull request label that triggers creation, when trigger_filter is label

branch_pattern

string

required

Glob matched against the branch name, when trigger_filter is branch_pattern

pr_name_pattern

string

required

Glob matched against the pull request title, when trigger_filter is pr_name_pattern

auto_deploy_on_push

boolean

required

Redeploy the preview environment on every push to its branch

cleanup_on_pr_merge

boolean

required

Destroy the preview environment when the pull request is merged

cleanup_on_pr_close

boolean

required

Destroy the preview environment when the pull request is closed unmerged

cleanup_on_branch_delete

boolean

required

Destroy the preview environment when its branch is deleted

cleanup_on_inactivity

boolean

required

Destroy the preview environment after inactivity_days without a commit

inactivity_days

integer<int32>

required

Days without a commit before cleanup, when cleanup_on_inactivity is on

retention_days

integer<int32>

required

Days a preview environment is kept before it expires

retention_mode

string

required

after_pr_close (count from PR close) or from_creation

comment_on_github

boolean

required

Post the preview environment URL as a pull request comment. Always off in every_branch mode

clone_settings

object

required

What is copied from the parent application. Keys clone_variables, clone_secret_files and clone_security default to true when absent; addons and cronjobs default to copying all

created_at

string<date-time>

required

Creation timestamp

updated_at

string<date-time>

required

Last update timestamp

Overview

Miget API

Set the preview environment config

Authorizations

Headers

Path Parameters

Body

Response