CLI Reference
- Get Started
- Root Command
- App Commands
- Auth Commands
- Resource Commands
- Project Commands
- Recipe Commands
API Reference
- Get Started
- Apps
- Resources
- Recipes
- Projects
Connect app version
Establish a connection with a specific version of an app, defining the resource types.
curl --request POST \
--url https://developer.tempestdx.com/api/v1/apps.version.connect \
--header 'Authorization: Bearer <token>' \
--header '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": "documentation"
}
]
},
"instructions_markdown": "<string>",
"lifecycle_stage": "<string>",
"actions": [
{
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"input_json_schema": {},
"output_json_schema": {}
}
]
}
]
}'
{
"status": "ok",
"message": "<string>",
"metadata": {
"tempest_app_url": "<string>"
},
"error": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The unique identifier of the application.
The version of the application.
The type of the resource.
The display name of the resource.
A description of the resource.
Whether the resource supports the list operation.
Whether the resource supports the read operation.
Whether the resource supports the create operation.
Whether the resource supports the update operation.
Whether the resource supports the delete operation.
Whether the resource supports health checks.
The lifecycle stage of this resource.
JSON schema defining properties of the resource.
JSON schema that defines the input for the create operation.
JSON schema that defines the input for the update operation.
Markdown instructions for the resource.
Actions that can be performed on this resource.
The unique name of the action.
The display name of the action.
A description of the action.
JSON schema defining the input for the action.
JSON schema defining the output for the action.
Response
Status of the report operation
ok
, error
A message providing additional information.
Error message if the operation fails.
Was this page helpful?
curl --request POST \
--url https://developer.tempestdx.com/api/v1/apps.version.connect \
--header 'Authorization: Bearer <token>' \
--header '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": "documentation"
}
]
},
"instructions_markdown": "<string>",
"lifecycle_stage": "<string>",
"actions": [
{
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"input_json_schema": {},
"output_json_schema": {}
}
]
}
]
}'
{
"status": "ok",
"message": "<string>",
"metadata": {
"tempest_app_url": "<string>"
},
"error": "<string>"
}