Appearance

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' \
 -H "Content-Type: application/json" \
 --data '{
  "app_id": "string",
  "version": "string"
}'
JavaScript
fetch('https://developer.tempestdx.com/api/v1/apps.operations.next', {method:'POST',headers:{'Content-Type':'application/json'},body:'{"app_id":"string","version":"string"}'})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://developer.tempestdx.com/api/v1/apps.operations.next';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];
$body = json_encode({"app_id":"string","version":"string"});

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://developer.tempestdx.com/api/v1/apps.operations.next'

headers = {
    'Content-Type': 'application/json'
}
data = {
    'app_id': 'string',
    'version': 'string'
}

response = requests.post(url, headers=headers, json=data)
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' \
 -H "Content-Type: application/json" \
 --data '{
  "response": null,
  "task_id": "string",
  "status": "string",
  "message": "string"
}'
JavaScript
fetch('https://developer.tempestdx.com/api/v1/apps.operations.report', {method:'POST',headers:{'Content-Type':'application/json'},body:'{"response":null,"task_id":"string","status":"string","message":"string"}'})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://developer.tempestdx.com/api/v1/apps.operations.report';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];
$body = json_encode({"response":null,"task_id":"string","status":"string","message":"string"});

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://developer.tempestdx.com/api/v1/apps.operations.report'

headers = {
    'Content-Type': 'application/json'
}
data = {
    'response': null,
    'task_id': 'string',
    'status': 'string',
    'message': 'string'
}

response = requests.post(url, headers=headers, json=data)
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' \
 -H "Content-Type: application/json" \
 --data '{
  "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": {}
        }
      ]
    }
  ]
}'
JavaScript
fetch('https://developer.tempestdx.com/api/v1/apps.version.connect', {method:'POST',headers:{'Content-Type':'application/json'},body:'{"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":{}}]}]}'})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://developer.tempestdx.com/api/v1/apps.version.connect';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];
$body = json_encode({"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":{}}]}]});

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://developer.tempestdx.com/api/v1/apps.version.connect'

headers = {
    'Content-Type': 'application/json'
}
data = {
    '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': {}
                }
            ]
        }
    ]
}

response = requests.post(url, headers=headers, json=data)
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' \
 -H "Content-Type: application/json" \
 --data '{
  "app_id": "string",
  "version": "string",
  "health_reports": [
    {
      "type": "string",
      "status": "string",
      "message": "string"
    }
  ]
}'
JavaScript
fetch('https://developer.tempestdx.com/api/v1/apps.versions.health', {method:'POST',headers:{'Content-Type':'application/json'},body:'{"app_id":"string","version":"string","health_reports":[{"type":"string","status":"string","message":"string"}]}'})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://developer.tempestdx.com/api/v1/apps.versions.health';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];
$body = json_encode({"app_id":"string","version":"string","health_reports":[{"type":"string","status":"string","message":"string"}]});

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://developer.tempestdx.com/api/v1/apps.versions.health'

headers = {
    'Content-Type': 'application/json'
}
data = {
    'app_id': 'string',
    'version': 'string',
    'health_reports': [
        {
            'type': 'string',
            'status': 'string',
            'message': 'string'
        }
    ]
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
Powered by VitePress OpenAPI