GitHub: Create a cluster deployment records job

← Orgs operations · Get started

Operation github.orgs_create_cluster_deployment_records_job

Provider route: POST /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["orgs"]["orgsCreateClusterDeploymentRecordsJob"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.orgs.orgsCreateClusterDeploymentRecordsJob(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.orgs.orgs_create_cluster_deployment_records_job(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.org	string	Required within parent
path.cluster	string	Required within parent	Maximum length: 128 Minimum length: 1 Pattern: ^[a-zA-Z0-9._-]+$
body	object	Required within parent
body.deployments	array	Required within parent	The list of deployments to record. Maximum items: 5000
body.deployments[]	object	Each item
body.deployments[].deployment_name	string	Required within parent	The unique identifier for the deployment represented by the new record. Maximum length: 256 Minimum length: 1
body.deployments[].digest	string	Required within parent	The hex encoded digest of the artifact. Maximum length: 71 Minimum length: 71 Pattern: ^sha256:[a-f0-9]{64}$
body.deployments[].github_repository	string	Optional	The name of the GitHub repository associated with the artifact. Maximum length: 100 Pattern: ^[A-Za-z0-9.-_]+$
body.deployments[].name	string	Required within parent	The name of the artifact. Maximum length: 256 Minimum length: 1
body.deployments[].runtime_risks	array	Optional	A list of runtime risks associated with the deployment. Maximum items: 4 Unique items: true
body.deployments[].runtime_risks[]	string	Each item	One of: critical-resource, internet-exposed, lateral-movement, sensitive-data
body.deployments[].status	string	Optional	The deployment status of the artifact. Default: deployed One of: deployed, decommissioned
body.deployments[].tags	object	Optional	Key-value pairs to tag the deployment record. Additional keys: see wildcard field
body.deployments[].tags.*	string	Additional keys
body.deployments[].version	string	Optional	The artifact version. Maximum length: 100
body.logical_environment	string	Required within parent	The stage of the deployment. Maximum length: 128 Minimum length: 1
body.physical_environment	string	Optional	The physical region of the deployment. Maximum length: 128

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
errors	array	Optional	Deployments that were rejected during authorization.
errors[]	object	Each item
job_id	JSON	Required within parent
job_id (anyOf 1)	integer	Alternative	The ID of the created job.
job_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.orgs_create_cluster_deployment_records_job. Catalog operation: orgs/create-cluster-deployment-records-job. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source