curl -X POST 'https://api.github.com/orgs/example-org/artifacts/metadata/deployment-record/cluster/example-cluster/jobs' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "logical_environment": "example-logical-environment",
  "deployments": [
    {
      "name": "example-name",
      "digest": "example-digest",
      "version": "1.2.3",
      "status": "deployed",
      "deployment_name": "example-deployment-name",
      "github_repository": "my-github-repo",
      "tags": {},
      "runtime_risks": [
        "critical-resource"
      ]
    }
  ]
}'

# POST /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs (GitHub API)
Base URL: https://api.github.com
Auth: Authorization; GitHub token; required.
Request formats: application/json.
Last verified: 2026-10-20

> Create a cluster deployment records job

## Critical Gotchas
* GitHub recommends an `Accept: application/vnd.github+json` header and an explicit `X-GitHub-Api-Version` header.
* Fine-grained tokens only authorize repositories and permissions selected when the token is created.

## cURL
curl -X POST 'https://api.github.com/orgs/example-org/artifacts/metadata/deployment-record/cluster/example-cluster/jobs' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "logical_environment": "example-logical-environment",
  "deployments": [
    {
      "name": "example-name",
      "digest": "example-digest",
      "version": "1.2.3",
      "status": "deployed",
      "deployment_name": "example-deployment-name",
      "github_repository": "my-github-repo",
      "tags": {},
      "runtime_risks": [
        "critical-resource"
      ]
    }
  ]
}'

## Parameters
| Name | In | Type | Required | Description |
| :--- | :--- | :--- | :--- | :--- |
| org | path | string | Yes | The organization name. The name is not case sensitive. |
| cluster | path | string | Yes | The cluster name. |
| logical_environment | body | string | Yes | The stage of the deployment. |
| deployments | body | object[] | Yes | The list of deployments to record. |
| physical_environment | body | string | No | The physical region of the deployment. |

## Response example
{"job_id":0,"errors":[{}]}

---
Need an API key? Get one at https://github.com/settings/tokens

POST

POST /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Create a cluster deployment records job

Base URL: https://api.github.com
Auth: Authorization: Bearer <GITHUB_API_KEY>
Last verified: 2026-10-20 · upstream hash matched

Actions Try in browser→

Agents: curl -H "Accept: text/markdown" this URL
→ 290 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X POST 'https://api.github.com/orgs/example-org/artifacts/metadata/deployment-record/cluster/example-cluster/jobs' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10' \  -H 'Content-Type: application/json' \  -d '{  "logical_environment": "example-logical-environment",  "deployments": [    {      "name": "example-name",      "digest": "example-digest",      "version": "1.2.3",      "status": "deployed",      "deployment_name": "example-deployment-name",      "github_repository": "my-github-repo",      "tags": {},      "runtime_risks": [        "critical-resource"      ]    }  ]}'

Parameters

Name	In	Type	Required	Description
org	path	string	Yes	The organization name. The name is not case sensitive.
cluster	path	string	Yes	The cluster name.
logical_environment	body	string	Yes	The stage of the deployment.
physical_environment	body	string	No	The physical region of the deployment.
deployments	body	object[]	Yes	The list of deployments to record.

Response 200 OK

{
  "job_id": 0,
  "errors": [
    {}
  ]
}

Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.