Validate Container Image for TVC

Validate a container image URL and pull secret for TVC deployment

organizationId · string · required

Unique identifier for a given Organization.

pivotContainerImageUrl · string · required

URL of the container image.

pivotContainerEncryptedPullSecret · string

HPKE-encrypted pull secret for private images.

A successful response returns the following fields:

resolvedImageDigest · string

resolvedImageDigest field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/validate_tvc_image \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "pivotContainerImageUrl": "<string>",
    "pivotContainerEncryptedPullSecret": "<string>"
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().validateTvcImage({
  organizationId: "<string> (Unique identifier for a given Organization.)",
  pivotContainerImageUrl: "<string> (URL of the container image.)",
  pivotContainerEncryptedPullSecret: "<string> (HPKE-encrypted pull secret for private images.)"
});

200

{
  "resolvedImageDigest": "<string>"
}