Update background process
curl --request PATCH \
--url https://cloud.laravel.com/api/background-processes/{backgroundProcess} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"processes": 5,
"command": "<string>",
"config": {
"connection": "<string>",
"queue": "<string>",
"tries": 123,
"backoff": 123,
"sleep": 123,
"rest": 123,
"timeout": 123,
"force": true
}
}
'import requests
url = "https://cloud.laravel.com/api/background-processes/{backgroundProcess}"
payload = {
"processes": 5,
"command": "<string>",
"config": {
"connection": "<string>",
"queue": "<string>",
"tries": 123,
"backoff": 123,
"sleep": 123,
"rest": 123,
"timeout": 123,
"force": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
processes: 5,
command: '<string>',
config: {
connection: '<string>',
queue: '<string>',
tries: 123,
backoff: 123,
sleep: 123,
rest: 123,
timeout: 123,
force: true
}
})
};
fetch('https://cloud.laravel.com/api/background-processes/{backgroundProcess}', 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://cloud.laravel.com/api/background-processes/{backgroundProcess}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'processes' => 5,
'command' => '<string>',
'config' => [
'connection' => '<string>',
'queue' => '<string>',
'tries' => 123,
'backoff' => 123,
'sleep' => 123,
'rest' => 123,
'timeout' => 123,
'force' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://cloud.laravel.com/api/background-processes/{backgroundProcess}"
payload := strings.NewReader("{\n \"processes\": 5,\n \"command\": \"<string>\",\n \"config\": {\n \"connection\": \"<string>\",\n \"queue\": \"<string>\",\n \"tries\": 123,\n \"backoff\": 123,\n \"sleep\": 123,\n \"rest\": 123,\n \"timeout\": 123,\n \"force\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://cloud.laravel.com/api/background-processes/{backgroundProcess}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"processes\": 5,\n \"command\": \"<string>\",\n \"config\": {\n \"connection\": \"<string>\",\n \"queue\": \"<string>\",\n \"tries\": 123,\n \"backoff\": 123,\n \"sleep\": 123,\n \"rest\": 123,\n \"timeout\": 123,\n \"force\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.laravel.com/api/background-processes/{backgroundProcess}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"processes\": 5,\n \"command\": \"<string>\",\n \"config\": {\n \"connection\": \"<string>\",\n \"queue\": \"<string>\",\n \"tries\": 123,\n \"backoff\": 123,\n \"sleep\": 123,\n \"rest\": 123,\n \"timeout\": 123,\n \"force\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "background_processes",
"attributes": {
"processes": 123,
"command": "<string>",
"config": [
"<unknown>"
],
"strategy_threshold": 123,
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"instance": {
"data": {
"type": "instances",
"id": "<string>"
}
}
}
},
"included": [
{
"id": "<string>",
"type": "instances",
"attributes": {
"name": "<string>",
"min_replicas": 123,
"max_replicas": 123,
"paused": true,
"is_default": true,
"visibility_timeout": 123,
"polling_interval": 123,
"shutdown_timeout": 123,
"uses_scheduler": true,
"sleep_with_app": true,
"scaling_cpu_threshold_percentage": 123,
"scaling_memory_threshold_percentage": 123,
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"environment": {
"data": {
"type": "environments",
"id": "<string>"
}
},
"backgroundProcesses": {
"data": [
{
"type": "background_processes",
"id": "<string>"
}
]
}
}
}
]
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Background Processes
Update background process
Update a background process.
PATCH
/
background-processes
/
{backgroundProcess}
Update background process
curl --request PATCH \
--url https://cloud.laravel.com/api/background-processes/{backgroundProcess} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"processes": 5,
"command": "<string>",
"config": {
"connection": "<string>",
"queue": "<string>",
"tries": 123,
"backoff": 123,
"sleep": 123,
"rest": 123,
"timeout": 123,
"force": true
}
}
'import requests
url = "https://cloud.laravel.com/api/background-processes/{backgroundProcess}"
payload = {
"processes": 5,
"command": "<string>",
"config": {
"connection": "<string>",
"queue": "<string>",
"tries": 123,
"backoff": 123,
"sleep": 123,
"rest": 123,
"timeout": 123,
"force": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
processes: 5,
command: '<string>',
config: {
connection: '<string>',
queue: '<string>',
tries: 123,
backoff: 123,
sleep: 123,
rest: 123,
timeout: 123,
force: true
}
})
};
fetch('https://cloud.laravel.com/api/background-processes/{backgroundProcess}', 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://cloud.laravel.com/api/background-processes/{backgroundProcess}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'processes' => 5,
'command' => '<string>',
'config' => [
'connection' => '<string>',
'queue' => '<string>',
'tries' => 123,
'backoff' => 123,
'sleep' => 123,
'rest' => 123,
'timeout' => 123,
'force' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://cloud.laravel.com/api/background-processes/{backgroundProcess}"
payload := strings.NewReader("{\n \"processes\": 5,\n \"command\": \"<string>\",\n \"config\": {\n \"connection\": \"<string>\",\n \"queue\": \"<string>\",\n \"tries\": 123,\n \"backoff\": 123,\n \"sleep\": 123,\n \"rest\": 123,\n \"timeout\": 123,\n \"force\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://cloud.laravel.com/api/background-processes/{backgroundProcess}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"processes\": 5,\n \"command\": \"<string>\",\n \"config\": {\n \"connection\": \"<string>\",\n \"queue\": \"<string>\",\n \"tries\": 123,\n \"backoff\": 123,\n \"sleep\": 123,\n \"rest\": 123,\n \"timeout\": 123,\n \"force\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.laravel.com/api/background-processes/{backgroundProcess}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"processes\": 5,\n \"command\": \"<string>\",\n \"config\": {\n \"connection\": \"<string>\",\n \"queue\": \"<string>\",\n \"tries\": 123,\n \"backoff\": 123,\n \"sleep\": 123,\n \"rest\": 123,\n \"timeout\": 123,\n \"force\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "background_processes",
"attributes": {
"processes": 123,
"command": "<string>",
"config": [
"<unknown>"
],
"strategy_threshold": 123,
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"instance": {
"data": {
"type": "instances",
"id": "<string>"
}
}
}
},
"included": [
{
"id": "<string>",
"type": "instances",
"attributes": {
"name": "<string>",
"min_replicas": 123,
"max_replicas": 123,
"paused": true,
"is_default": true,
"visibility_timeout": 123,
"polling_interval": 123,
"shutdown_timeout": 123,
"uses_scheduler": true,
"sleep_with_app": true,
"scaling_cpu_threshold_percentage": 123,
"scaling_memory_threshold_percentage": 123,
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"environment": {
"data": {
"type": "environments",
"id": "<string>"
}
},
"backgroundProcesses": {
"data": [
{
"type": "background_processes",
"id": "<string>"
}
]
}
}
}
]
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Authorizations
The Bearer Token generated on the Cloud UI.
Path Parameters
The background process identifier
Body
application/json
Was this page helpful?
⌘I

