Skip to content
v1.0.0

Private Apps API

API for Private Apps to connect to Tempest.

Servers

https://developer.tempestdx.com/api/v1Production server

Default


Retrieve the next task to execute

POST
/apps.operations.next

Fetch the next available task for execution by an external client.

Authorizations

Request Body

JSON
{
"app_id": "string",
"version": "string"
}

Responses

The next task to execute
JSON
{
"task": null,
"task_id": "string",
"metadata": {
"owners": [
{
"email": "string",
"name": "string",
"type": "string"
}
],
"author": {
"email": "string",
"name": "string",
"type": "string"
},
"project_id": "string",
"project_name": "string"
}
}

Samples

cURL
curl -X POST https://developer.tempestdx.com/api/v1/apps.operations.next
JavaScript
fetch("https://developer.tempestdx.com/api/v1/apps.operations.next", { method: "POST" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://developer.tempestdx.com/api/v1/apps.operations.next");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.post("https://developer.tempestdx.com/api/v1/apps.operations.next")
print(response.json())

Report the result of a task execution

POST
/apps.operations.report

Clients report task completion or failure using this endpoint.

Authorizations

Request Body

JSON
{
"response": null,
"task_id": "string",
"status": "string",
"message": "string"
}

Responses

Task report received successfully.
JSON
{
"status": "string",
"message": "string",
"metadata": {
"tempest_app_url": "string"
},
"error": "string"
}

Samples

cURL
curl -X POST https://developer.tempestdx.com/api/v1/apps.operations.report
JavaScript
fetch("https://developer.tempestdx.com/api/v1/apps.operations.report", { method: "POST" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://developer.tempestdx.com/api/v1/apps.operations.report");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.post("https://developer.tempestdx.com/api/v1/apps.operations.report")
print(response.json())

Connect to a specific app version

POST
/apps.version.connect

Establish a connection with a specific version of an app, defining the resource types.

Authorizations

Request Body

JSON
{
"app_id": "string",
"version": "string",
"resources": [
{
"type": "string",
"display_name": "string",
"description": "string",
"property_json_schema": {
},
"list_supported": true,
"read_supported": true,
"create_supported": true,
"create_input_schema": {
},
"update_supported": true,
"update_input_schema": {
},
"delete_supported": true,
"healthcheck_supported": true,
"links": {
"links": [
{
"title": "string",
"url": "string",
"type": "string"
}
]
},
"instructions_markdown": "string",
"lifecycle_stage": "string",
"actions": [
{
"name": "string",
"display_name": "string",
"description": "string",
"input_json_schema": {
},
"output_json_schema": {
}
}
]
}
]
}

Responses

Successfully connected to the app version.
JSON
{
"status": "string",
"message": "string",
"metadata": {
"tempest_app_url": "string"
},
"error": "string"
}

Samples

cURL
curl -X POST https://developer.tempestdx.com/api/v1/apps.version.connect
JavaScript
fetch("https://developer.tempestdx.com/api/v1/apps.version.connect", { method: "POST" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://developer.tempestdx.com/api/v1/apps.version.connect");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.post("https://developer.tempestdx.com/api/v1/apps.version.connect")
print(response.json())

Handles health check reports for apps

POST
/apps.versions.health

Clients report health check results using this endpoint.

Authorizations

Request Body

JSON
{
"app_id": "string",
"version": "string",
"health_reports": [
{
"type": "string",
"status": "string",
"message": "string"
}
]
}

Responses

Received health check report
JSON
{
"status": "string",
"message": "string",
"metadata": {
"tempest_app_url": "string"
},
"error": "string"
}

Samples

cURL
curl -X POST https://developer.tempestdx.com/api/v1/apps.versions.health
JavaScript
fetch("https://developer.tempestdx.com/api/v1/apps.versions.health", { method: "POST" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://developer.tempestdx.com/api/v1/apps.versions.health");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.post("https://developer.tempestdx.com/api/v1/apps.versions.health")
print(response.json())

Powered by VitePress OpenAPI