DeployGate API Reference

DeployGate provides API to support the automated management of applications and users. Using these APIs, you can customize the upload from CI and link member additions/deletions with other systems.

• You can see API keys to call the API from the account setting.
• You can use different APIs for Project/Organization and Workspace.
  • Notice: For Using Project/Organization API
  • Notice: For Using Workspace API

Use these APIs from an AI agent

Most of the operations documented here are also available through the DeployGate MCP server (@deploygate/mcp), so you can drive them from an AI coding agent in natural language — without handling API keys yourself. It works with Claude Code, Codex, and any MCP-compatible client. See the DeployGate Agent Plugin and the Standalone MCP Server guide.

Confirm API Key

There are 3 kinds of API keys in DeployGate, for users, Projects/Organizations, and Workspaces respectively.

Users

API Key of the user is listed in the profile page.

Projects/Organizations

Press "Show Project/Organization's API Key" to show API Key of the Project/Organization.

Workspaces

Review the Using the Workspace API Key page.