curl --request GET \
--url https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}', 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://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"tenant_id": "5c0e7a92-3f4b-4d1e-a8c6-7b2d9e1f0a34",
"tenant_number": 4194321,
"job_id": "e4a7c1d2-9b3f-4e8a-a2c5-1f6d7b8e9a01",
"status": "queued",
"tenant_host": "cc4a1b2c.cyrisma.com",
"registration_key": "9F2C4A7B1E3D5C6A8B0F2E4D6C8A0B1C",
"orchestrator_wake_succeeded": null
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Get a provisioning job's status
Returns the current state of a create or decommission job. Poll it until status is
deployed, decommissioned or failed. Needs pulse.write.
- 401 (no body): missing or invalid token, no
pulse.write, or the job’s tenant is outside your hierarchy. - 404 (no body): no job has this id.
curl --request GET \
--url https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}', 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://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.cyrisma.com/ta/v1/msp/provisioning/jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"tenant_id": "5c0e7a92-3f4b-4d1e-a8c6-7b2d9e1f0a34",
"tenant_number": 4194321,
"job_id": "e4a7c1d2-9b3f-4e8a-a2c5-1f6d7b8e9a01",
"status": "queued",
"tenant_host": "cc4a1b2c.cyrisma.com",
"registration_key": "9F2C4A7B1E3D5C6A8B0F2E4D6C8A0B1C",
"orchestrator_wake_succeeded": null
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.
Path Parameters
Response
OK
A tenant lifecycle job, returned by Provision a tenant, Get a provisioning job's status
and Decommission a tenant. Jobs run asynchronously: poll Get a provisioning job's status
(GET /v1/msp/provisioning/jobs/{jobId}) with job_id until status is deployed (create),
decommissioned (decommission) or failed.
The job's status: queued | leased | running | deployed | decommissioned | failed.
queued: accepted, waiting for a worker. A new create or decommission always starts here.leased/running: a worker has picked it up.deployed: the tenant is ready and its status is nowactive.decommissioned: the tenant is removed and its status is nowdeleted.failed: the job did not complete.
