apicheats.dev Cheat sheet Raw .md
POST

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

GitHub playground

Set cluster deployment records

Credentials

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Path

Body application/json

5 body fields
  • logical_environment · required · string — The stage of the deployment.
  • physical_environment · optional · string — The physical region of the deployment.
  • deployments · required · object[] — The list of deployments to record.
  • partial_success · optional · boolean — When enabled, deployments associated with repositories the actor can write to are processed while deployments associated with repositories that cannot be resolved or written to by the actor are skipped and reported in the `errors` array. When false (the default), the endpoint returns an error if any targeted repository cannot be resolved, the actor lacks write access, or no matching attestation can be found.
  • return_records · optional · boolean — If true, the endpoint will return the set records in the response body