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.

​
organizationId
string
required
Unique identifier for a given organization.
​
deploymentId
string
required
Unique identifier for a given TVC Deployment.
A successful response returns the following fields:
​
tvcDeployment
object
required
tvcDeployment field
curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_tvc_deployment \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "deploymentId": "<string>"
}'

{
  "tvcDeployment": {
    "id": "<string>",
    "organizationId": "<string>",
    "appId": "<string>",
    "manifestSet": {
      "id": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "operators": [
        {
          "id": "<string>",
          "name": "<string>",
          "publicKey": "<string>",
          "createdAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          },
          "updatedAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          }
        }
      ],
      "threshold": "<number>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    },
    "shareSet": {
      "id": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "operators": [
        {
          "id": "<string>",
          "name": "<string>",
          "publicKey": "<string>",
          "createdAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          },
          "updatedAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          }
        }
      ],
      "threshold": "<number>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    },
    "manifest": {
      "id": "<string>",
      "manifest": "<string>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    },
    "manifestApprovals": [
      {
        "id": "<string>",
        "manifestId": "<string>",
        "operator": {
          "id": "<string>",
          "name": "<string>",
          "publicKey": "<string>",
          "createdAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          },
          "updatedAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          }
        },
        "approval": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        }
      }
    ],
    "qosVersion": "<string>",
    "pivotContainer": {
      "containerUrl": "<string>",
      "path": "<string>",
      "args": [
        "<string>"
      ],
      "hasPullSecret": "<boolean>",
      "healthCheckType": "<TVC_HEALTH_CHECK_TYPE_HTTP>",
      "healthCheckPort": "<number>",
      "publicIngressPort": "<number>"
    },
    "createdAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    },
    "updatedAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    },
    "delete": "<boolean>"
  }
}