API & MCP

REST API

Mint an API key under Settings → API keys — keys carry a role (admin / deployer / viewer), an environment scope, and secret visibility, enforced server-side. Authenticate with Authorization: Bearer yakd_….

GET  /api/v1/projects
POST /api/v1/projects
GET  /api/v1/projects/:id
POST /api/v1/projects/:id/environments
POST /api/v1/projects/:id/steps
POST /api/v1/projects/:id/releases      # cut a release
GET  /api/v1/deployments
POST /api/v1/deployments                # deploy a release
GET  /api/v1/deployments/:id
GET  /api/v1/deployments/:id/logs

A minimal CI integration is two calls: cut a release, then deploy it and poll GET /api/v1/deployments/:id until it reaches a terminal state.

MCP (AI agents)

YakDeploy speaks the Model Context Protocol natively, so Claude, Cursor, and other MCP clients can list projects, cut releases, deploy, and read logs — with the same RBAC as everyone else (OAuth 2.1; the token carries role + environment scope). Settings → MCP apps has the connect URL and per-client instructions. Tools: list_projects · get_project · create_project · add_environment · add_step · cut_release · deploy · deployment_status · deployment_logs · list_deployments · whats_deployed · preview_variables · list_runbooks · run_runbook · rollback · search_logs · get_audit_events · explain_failure — an agent can diagnose a failed deploy in one explain_failure call and act on it.