Status of one deployment service (registry + guest supervisor observation)
curl --request GET \
--url https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId} \
--header 'x-access-token: <api-key>'import requests
url = "https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}', 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://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"serviceId": "68be1f0a4b2c1d0012a4f001",
"kind": "dev",
"environment": "staging",
"revisionId": "0123456789abcdef0123456789abcdef",
"artifactId": "<string>",
"generation": 123,
"status": "starting",
"health": {
"observedAt": "2023-11-07T05:31:56Z",
"detail": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"success": true,
"ok": true,
"guestReachable": true,
"stale": true
}{
"success": false,
"message": "not-found"
}Agentspace
Status of one deployment service (registry + guest supervisor observation)
GET
/
api
/
user
/
agentspace
/
{projectId}
/
deployments
/
{serviceId}
Status of one deployment service (registry + guest supervisor observation)
curl --request GET \
--url https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId} \
--header 'x-access-token: <api-key>'import requests
url = "https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}', 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://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/agentspace/{projectId}/deployments/{serviceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"serviceId": "68be1f0a4b2c1d0012a4f001",
"kind": "dev",
"environment": "staging",
"revisionId": "0123456789abcdef0123456789abcdef",
"artifactId": "<string>",
"generation": 123,
"status": "starting",
"health": {
"observedAt": "2023-11-07T05:31:56Z",
"detail": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"success": true,
"ok": true,
"guestReachable": true,
"stale": true
}{
"success": false,
"message": "not-found"
}Authorizations
JWT token passed in x-access-token header
Response
The service, plus guest ({state, generation, exitCode, since} or null when unreachable) and stale when the guest generation differs from the registered one
A registered worker-backed service instance (dev preview or release candidate). VM addresses/ports are never exposed.
Example:
"68be1f0a4b2c1d0012a4f001"
Available options:
dev, release Available options:
staging, production, dev 32-hex site revision (release services only; empty for dev)
Example:
"0123456789abcdef0123456789abcdef"
Supervisor process generation — the fence every stop carries
Available options:
starting, ready, unhealthy, unreachable, stopping, stopped, failed Show child attributes
Show child attributes
Was this page helpful?