essesseff Skill

This skill covers two complementary ways to work with the essesseff DevOps platform:

1. essesseff Public API — direct HTTP calls for managing templates, organizations, apps, images, deployments, environments, packages, and retention policies.
2. essesseff Onboarding Utility — shell scripts that automate app creation and Argo CD deployment setup.

Quick Reference

Base URL:

https://www.essesseff.com/api/v1

www

Authentication: All requests require

X-API-Key: ess_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Rate limit: 3 requests per 10 seconds. Headers:

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

Path structure:

• Global (no account needed):

  /api/v1/global/...

• Account-specific:

  /api/v1/accounts/{account_slug}/...

  — API key must belong to the

  account_slug

  in the path or a

  403

  is returned.

API Reference Files

For full endpoint details, request/response examples, and query parameters, see:

references/api-overview.md

references/api-templates.md

references/api-organizations.md

references/api-apps.md

references/api-images.md

references/api-images.md

references/api-environments.md

references/api-packages.md

references/api-retention-policies.md

API Endpoint Map

Global

/global/templates

?language=go|python|node|java|rust|php

/global/templates/{template_name}

Account-Specific (all require matching API key)

/accounts/{account_slug}/templates

/accounts/{account_slug}/templates/{template_name}

/accounts/{account_slug}/organizations

/accounts/{account_slug}/organizations/{org_login}

/accounts/{account_slug}/organizations/{org_login}/apps

/accounts/{account_slug}/organizations/{org_login}/apps?app_name={name}

/accounts/{account_slug}/organizations/{org_login}/apps/{app_name}

/accounts/{account_slug}/organizations/{org_login}/apps/{app_name}

.../apps/{app_name}/deployments

.../apps/{app_name}/images

.../apps/{app_name}/images/{image_tag}

.../apps/{app_name}/images/{image_tag}/lifecycle

.../apps/{app_name}/images/{image_tag}/lifecycle

.../apps/{app_name}/environments/{env}

.../apps/{app_name}/environments/{env}/set-argocd-application-url

.../apps/{app_name}/environments/DEV/declare-rc

.../apps/{app_name}/environments/QA/accept-rc

.../apps/{app_name}/environments/QA/reject-rc

.../apps/{app_name}/environments/QA/declare-stable

.../apps/{app_name}/environments/QA/declare-rejected

.../apps/{app_name}/environments/STAGING/deploy-stable

.../apps/{app_name}/environments/PROD/deploy-stable

.../apps/{app_name}/notifications-secret

.../apps/{app_name}/packages/delete-packages

.../apps/{app_name}/retention-policies

?state=

.../apps/{app_name}/retention-policies?state={state}

Image Lifecycle State Machine

Images progress through states in this order:

BUILD → DEV → RC → QA → STABLE → STAGING → PROD
              ↑  ↓  ↓
            REJECTED

Key transitions via API:

• DEV/declare-rc

  — promotes current DEV image to RC (no body)

• QA/accept-rc

  — body:

  {"image_tag": "v1.2.3"}

  → sets QA, deploys to QA

• QA/reject-rc

  — body:

  {"image_tag": "v1.2.3"}

  → sets REJECTED

• QA/declare-stable

  — no body → sets STABLE on current QA image

• QA/declare-rejected

  — no body → sets REJECTED on current QA image

• STAGING/deploy-stable

  — body:

  {"image_tag": "v1.2.3"}

  → deploys to STAGING

• PROD/deploy-stable

  — body:

  {"image_tag": "v1.2.3", "deployment_note": "CR#123"}

  → deploys to PROD (no OTP required via API)

Alternatively, use

POST .../images/{image_tag}/lifecycle

{"state": "QA"}

Onboarding Utility Reference

For shell-script-based automation (no API calls required), see:

references/onboarding-utility.md

references/prerequisites.md

references/non-subscriber-mode.md

The utility (

essesseff-onboard.sh

• --list-templates

  — list available templates

• --create-app

  — create all 9 repos (via API for subscribers, clone/replace/push for non-subscribers)

• --setup-argocd dev,qa,staging,prod

  — configure Argo CD for each environment

• --non-essesseff-subscriber-mode

  — no essesseff API required

• --config-file .essesseff

  — path to config file

• --verbose

  — debug output

Common Errors

account_slug