Skip to main content

Kinsta

@jayr/kinstav2026.11.20.2· MIT· 1d agoBEHAVIORS
01README

Sites, environments and backups of a Kinsta company through the Kinsta API. sites lists every site with its environments. backups lists the backups of one environment. create_backup asks for one manual backup and waits until Kinsta lists it; it refuses at the manual limit and finds a recent backup with the same tag again instead of making a second one. It never restores, deletes or pushes anything. The API key comes from a vault and is never logged or stored.

02Release Notes

Same code as 2026.11.20.1, published again so the registry record carries the review report.

03Behaviors1
@jayr/kinstav2026.11.20.2kinsta.ts

Global Arguments

ArgumentTypeDescription
apiKeystringKinsta API key. Keep it in a vault and reference it with a vault.get expression; never write the key itself in a definition
companyIdstringKinsta company id (MyKinsta > Company settings > Billing details shows it), a UUID
fn sites()
List every site of the company with its environments. Read-only (one GET, repeated only when it fails)
fn backups()
List the backups of one environment, manual and automatic. Read-only (one GET, repeated only when it fails)
fn create_backup(tag: string, waitMinutes?: number, pollSeconds?: number, manualLimit?: number, whenFull?: enum, reuseWithinMinutes?: number)
Ask Kinsta for one manual backup of one environment and wait until Kinsta lists it. Refuses at the manual limit unless told to proceed; finds a recent backup with the same tag again instead of making a second one. Fails the run when the backup is not listed in time
ArgumentTypeDescription
tagstringTag (note) of the new backup, e.g. before-plugin-update. Lowercase letters, digits and single hyphens, up to 40 characters
waitMinutes?numberAbout how long to wait for Kinsta to list the new backup before the run fails
pollSeconds?numberSeconds between two reads of the backup list while waiting
manualLimit?numberHow many manual backups Kinsta keeps for one environment (5 unless your account differs)
whenFull?enumAt the manual limit: refuse (default, nothing is requested) or proceed and let Kinsta decide what happens to the oldest one
reuseWithinMinutes?numberWhen a manual backup with the same tag was made in the last this-many minutes, record that one instead of asking for another. 0 always asks for a new one

Resources

sites(infinite)— Every site of the company with its environments (ids, names, primary domain, WordPress and PHP version)
backups(infinite)— The backups Kinsta lists for one environment
backup(infinite)— The manual backup made (or found again) by create_backup for one environment
04Previous Versions1
2026.11.20.1MIT
05Stats
A
100 / 100
Downloads
4
Archive size
23.3 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels