Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.turnkey.com/llms.txt

Use this file to discover all available pages before exploring further.

​
type
enum<string>
required
Enum options: ACTIVITY_TYPE_CREATE_TVC_DEPLOYMENT
​
timestampMs
string
required
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
​
organizationId
string
required
Unique identifier for a given Organization.
​
parameters
object
required

The parameters object containing the specific intent data for this activity.

A successful response returns the following fields:
​
activity
object
required
The activity object containing type, intent, and result
curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_tvc_deployment \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_TVC_DEPLOYMENT",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "appId": "<string>",
        "qosVersion": "<string>",
        "pivotContainerImageUrl": "<string>",
        "pivotPath": "<string>",
        "pivotArgs": [
            "<string>"
        ],
        "expectedPivotDigest": "<string>",
        "nonce": "<number>",
        "pivotContainerEncryptedPullSecret": "<string>",
        "debugMode": "<boolean>",
        "healthCheckType": "<TVC_HEALTH_CHECK_TYPE_HTTP>",
        "healthCheckPort": "<number>",
        "publicIngressPort": "<number>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_TVC_DEPLOYMENT",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createTvcDeploymentIntent": {
            "appId": "<string>",
            "qosVersion": "<string>",
            "pivotContainerImageUrl": "<string>",
            "pivotPath": "<string>",
            "pivotArgs": [
              "<string>"
            ],
            "expectedPivotDigest": "<string>",
            "nonce": "<number>",
            "pivotContainerEncryptedPullSecret": "<string>",
            "debugMode": "<boolean>",
            "healthCheckType": "<TVC_HEALTH_CHECK_TYPE_HTTP>",
            "healthCheckPort": "<number>",
            "publicIngressPort": "<number>"
          }
        },
        "result": {
          "createTvcDeploymentResult": {
            "deploymentId": "<string>",
            "manifestId": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}