Pipefork Management MCP
Manage Pipefork API projects, drafts, connections, secrets, and deployments through MCP.
Should I use this
Quality & Safety
A
Findings (3)
- LOWTool 'secret_deactivate' description lacks action verbin secret_deactivate
- LOWTool 'deployment_deploy' description lacks action verbin deployment_deploy
- LOWTool 'deployment_undeploy' description lacks action verbin deployment_undeploy
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
~9,949Tokens (tool definitions)
~3.9 KBTypical response size
Significant attention impact (7.77% of 128k context)
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"management": {
"url": "https://www.pipefork.com/mcp"
}
}
}Remote endpoints
https://www.pipefork.com/mcpstreamable-httpWhat it can do
Tool inventory
Tools (27)
🟢 Read-only🟡 Write🔴 Delete⚪ Unknown
🟢api_list(mode)
List APIs the authenticated caller may access in the current workspace.
Input Schema
{
"type": "object",
"properties": {
"mode": {
"default": "active",
"type": "string",
"enum": [
"active",
"archived"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived",
"pending_deletion",
"deleted"
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"slug",
"description",
"status",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"result"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢api_get(apiId)
Get one API by its stable API ID.
Input Schema
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived",
"pending_deletion",
"deleted"
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"allowedOrigins": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProdDeploymentHistory": {
"type": "boolean"
},
"environments": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"dev",
"test",
"prod"
]
},
"additionalProperties": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"dev",
"test",
"prod"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"deployed": {
"type": "boolean"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"deployedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"status",
"deployed",
"version",
"deployedAt"
],
"additionalProperties": false
},
"required": [
"dev",
"test",
"prod"
]
}
},
"required": [
"id",
"name",
"slug",
"description",
"status",
"createdAt",
"updatedAt",
"allowedOrigins",
"hasProdDeploymentHistory",
"environments"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟡api_create(name, slug, description)
Create an API in the authenticated caller workspace.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"slug": {
"type": "string",
"minLength": 2,
"pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"archived",
"pending_deletion",
"deleted"
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"allowedOrigins": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProdDeploymentHistory": {
"type": "boolean"
},
"environments": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"dev",
"test",
"prod"
]
},
"additionalProperties": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"dev",
"test",
"prod"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"deployed": {
"type": "boolean"
},
"version": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"deployedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"status",
"deployed",
"version",
"deployedAt"
],
"additionalProperties": false
},
"required": [
"dev",
"test",
"prod"
]
}
},
"required": [
"id",
"name",
"slug",
"description",
"status",
"createdAt",
"updatedAt",
"allowedOrigins",
"hasProdDeploymentHistory",
"environments"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢draft_get(apiId)
Retrieve the current canonical draft for an API by its stable API ID.
Input Schema
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
}
},
"required": [
"result"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢draft_validate(apiId)
Validate the current canonical draft for an API by its stable API ID.
Input Schema
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"valid",
"errors",
"warnings"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟡endpoint_create(endpointId, method, path, queryParameters, initialStepId, ...)
Create a structured endpoint in an API draft.
Input Schema
{
"type": "object",
"properties": {
"endpointId": {
"type": "string",
"minLength": 1
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"path": {
"type": "string",
"pattern": "^\\/.*"
},
"queryParameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"required": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"integer",
"boolean"
]
},
"description": {
"type": "string",
"minLength": 1
}
},
"required": [
"name",
"required"
],
"additionalProperties": false
}
},
"initialStepId": {
"type": "string",
"minLength": 1
},
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"endpointId",
"method",
"path",
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}🔴endpoint_update(endpointId, method, path, queryParameters, response, ...)
Update a structured endpoint in an API draft.
Input Schema
{
"type": "object",
"properties": {
"endpointId": {
"type": "string",
"minLength": 1
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"path": {
"type": "string",
"pattern": "^\\/.*"
},
"queryParameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"required": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"integer",
"boolean"
]
},
"description": {
"type": "string",
"minLength": 1
}
},
"required": [
"name",
"required"
],
"additionalProperties": false
}
},
"response": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "javascript"
},
"statusCode": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"code": {
"type": "string",
"minLength": 1
},
"schema": {
"$ref": "#/$defs/__schema0"
},
"example": {},
"validateInRuntime": {
"type": "boolean"
}
},
"required": [
"mode",
"code"
],
"additionalProperties": false
},
"examples": {
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"params": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"query": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"body": {}
}
},
"response": {}
}
},
"agentTool": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"toolName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"toolDescription": {
"type": "string",
"minLength": 1
},
"whenToUse": {
"type": "string",
"minLength": 1
},
"inputSchema": {
"$ref": "#/$defs/__schema0"
},
"outputSchema": {
"$ref": "#/$defs/__schema0"
},
"examplePrompts": {
"default": [],
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"errorSemantics": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"validation_failed",
"unauthorized",
"rate_limited",
"upstream_unavailable",
"upstream_timeout",
"composer_failed",
"internal_error"
]
}
}
},
"required": [
"enabled",
"toolName",
"toolDescription",
"inputSchema",
"outputSchema",
"errorSemantics"
]
},
"deprecation": {
"type": "object",
"properties": {
"deprecated": {
"type": "boolean"
},
"message": {
"type": "string"
},
"replacedBy": {
"type": "string"
}
},
"required": [
"deprecated"
]
},
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"endpointId",
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"default": {},
"enum": {
"type": "array",
"items": {}
},
"example": {},
"properties": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
},
"items": {
"$ref": "#/$defs/__schema0"
},
"nullable": {
"type": "boolean"
},
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/$defs/__schema0"
}
]
}
},
"additionalProperties": {}
}
}
}Output Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}🔴endpoint_delete(endpointId, apiId)
Delete a structured endpoint from an API draft.
Input Schema
{
"type": "object",
"properties": {
"endpointId": {
"type": "string",
"minLength": 1
},
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"endpointId",
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}🟡step_create(apiId, endpointId, stepId, step)
Create a supported structured step in an API draft endpoint.
Input Schema
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"endpointId": {
"type": "string",
"minLength": 1
},
"stepId": {
"type": "string",
"minLength": 1
},
"step": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "http_request"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"url": {
"type": "string",
"minLength": 1
},
"connectionId": {
"type": "string",
"minLength": 1
},
"relativePath": {
"type": "string",
"minLength": 1
},
"authProfileId": {
"type": "string",
"minLength": 1
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"query": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"body": {
"oneOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "json"
},
"value": {}
},
"required": [
"mode",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "javascript"
},
"code": {
"type": "string",
"minLength": 1
}
},
"required": [
"mode",
"code"
],
"additionalProperties": false
}
]
},
"timeoutMs": {
"type": "integer",
"minimum": 100,
"maximum": 60000
},
"parallelGroup": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$"
},
"condition": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"expression": {
"type": "string"
}
},
"required": [
"enabled"
],
"additionalProperties": false
},
"onError": {
"type": "string",
"enum": [
"stop",
"continue",
"fallback"
]
},
"fallbackValue": {}
},
"required": [
"type",
"outputName",
"method"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "static_json"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"value": {}
},
"required": [
"type",
"outputName",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "compute"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"code": {
"type": "string",
"minLength": 1
}
},
"required": [
"type",
"outputName",
"code"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "llm_provider"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"systemPromptTemplate": {
"type": "string"
},
"promptTemplate": {
"type": "string",
"minLength": 1
},
"responseFormat": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"json"
]
},
"schema": {}
},
"additionalProperties": false
},
"temperature": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"maxOutputTokens": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"timeoutMs": {
"type": "integer",
"minimum": 100,
"maximum": 60000
}
},
"required": [
"type",
"outputName",
"promptTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "transform"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"source": {
"type": "string",
"minLength": 1
},
"operations": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"maxOutputItems": {
"type": "integer",
"minimum": 1,
"maximum": 100000
}
},
"required": [
"type",
"outputName",
"source",
"operations"
],
"additionalProperties": false
}
]
}
},
"required": [
"apiId",
"endpointId",
"stepId",
"step"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}🔴step_update(apiId, endpointId, stepId, step)
Update a supported structured step in an API draft endpoint.
Input Schema
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"endpointId": {
"type": "string",
"minLength": 1
},
"stepId": {
"type": "string",
"minLength": 1
},
"step": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "http_request"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"url": {
"type": "string",
"minLength": 1
},
"connectionId": {
"type": "string",
"minLength": 1
},
"relativePath": {
"type": "string",
"minLength": 1
},
"authProfileId": {
"type": "string",
"minLength": 1
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"query": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"body": {
"oneOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "json"
},
"value": {}
},
"required": [
"mode",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "javascript"
},
"code": {
"type": "string",
"minLength": 1
}
},
"required": [
"mode",
"code"
],
"additionalProperties": false
}
]
},
"timeoutMs": {
"type": "integer",
"minimum": 100,
"maximum": 60000
},
"parallelGroup": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$"
},
"condition": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"expression": {
"type": "string"
}
},
"required": [
"enabled"
],
"additionalProperties": false
},
"onError": {
"type": "string",
"enum": [
"stop",
"continue",
"fallback"
]
},
"fallbackValue": {}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "static_json"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"value": {}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "compute"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"code": {
"type": "string",
"minLength": 1
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "llm_provider"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"systemPromptTemplate": {
"type": "string"
},
"promptTemplate": {
"type": "string",
"minLength": 1
},
"responseFormat": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"json"
]
},
"schema": {}
},
"additionalProperties": false
},
"temperature": {
"type": "number",
"minimum": 0,
"maximum": 2
},
"maxOutputTokens": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"timeoutMs": {
"type": "integer",
"minimum": 100,
"maximum": 60000
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "transform"
},
"outputName": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
},
"source": {
"type": "string",
"minLength": 1
},
"operations": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"maxOutputItems": {
"type": "integer",
"minimum": 1,
"maximum": 100000
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"required": [
"apiId",
"endpointId",
"stepId",
"step"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}🔴step_delete(endpointId, stepId, apiId)
Delete a structured step from an API draft endpoint.
Input Schema
{
"type": "object",
"properties": {
"endpointId": {
"type": "string",
"minLength": 1
},
"stepId": {
"type": "string",
"minLength": 1
},
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"endpointId",
"stepId",
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}🔴step_reorder(endpointId, stepIds, apiId)
Set the order of all steps in an API draft endpoint using stable step IDs.
Input Schema
{
"type": "object",
"properties": {
"endpointId": {
"type": "string",
"minLength": 1
},
"stepIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"endpointId",
"stepIds",
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}🟢secret_list
List metadata for secrets in the authenticated caller workspace.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"partial",
"disabled"
]
},
"environments": {
"type": "object",
"properties": {
"dev": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
},
"test": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
},
"prod": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"dev",
"test",
"prod"
],
"additionalProperties": false
}
},
"required": [
"name",
"description",
"updatedAt",
"status",
"environments"
],
"additionalProperties": false
}
}
},
"required": [
"result"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡secret_create(name, description, values)
Create a workspace secret. Submitted values are never returned.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"values": {
"type": "object",
"properties": {
"dev": {
"type": "string",
"minLength": 1,
"maxLength": 16384
},
"test": {
"type": "string",
"minLength": 1,
"maxLength": 16384
},
"prod": {
"type": "string",
"minLength": 1,
"maxLength": 16384
}
},
"additionalProperties": false
}
},
"required": [
"name",
"values"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"partial",
"disabled"
]
},
"environments": {
"type": "object",
"properties": {
"dev": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
},
"test": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
},
"prod": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"dev",
"test",
"prod"
],
"additionalProperties": false
}
},
"required": [
"name",
"description",
"updatedAt",
"status",
"environments"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴secret_rotate(name, values)
Rotate one workspace secret. Submitted values are never returned.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"values": {
"type": "object",
"properties": {
"dev": {
"type": "string",
"minLength": 1,
"maxLength": 16384
},
"test": {
"type": "string",
"minLength": 1,
"maxLength": 16384
},
"prod": {
"type": "string",
"minLength": 1,
"maxLength": 16384
}
},
"additionalProperties": false
}
},
"required": [
"name",
"values"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"partial",
"disabled"
]
},
"environments": {
"type": "object",
"properties": {
"dev": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
},
"test": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
},
"prod": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"dev",
"test",
"prod"
],
"additionalProperties": false
}
},
"required": [
"name",
"description",
"updatedAt",
"status",
"environments"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴secret_deactivate(name)
Deactivate one workspace secret without exposing its values.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
}
},
"required": [
"name"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"partial",
"disabled"
]
},
"environments": {
"type": "object",
"properties": {
"dev": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
},
"test": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
},
"prod": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"set",
"missing",
"disabled"
]
},
"updatedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"dev",
"test",
"prod"
],
"additionalProperties": false
}
},
"required": [
"name",
"description",
"updatedAt",
"status",
"environments"
],
"additionalProperties": false
}
}
},
"required": [
"result"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢connection_list
List safe metadata for upstream connections in the authorized workspace.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runtimeKind": {
"type": "string",
"enum": [
"http",
"llm"
]
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"defaultHeaders": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"runtimeKind",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"defaultHeaders",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"result"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢connection_get(id)
Get safe metadata for one upstream connection in the authorized workspace.
Input Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runtimeKind": {
"type": "string",
"enum": [
"http",
"llm"
]
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"defaultHeaders": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"runtimeKind",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"defaultHeaders",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"result"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡connection_create(name, description, runtimeKind, baseUrlByEnvironment, authProfileIdByEnvironment, ...)
Create an upstream connection using safe configuration and auth-profile references.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"runtimeKind": {
"default": "http",
"type": "string",
"enum": [
"http",
"llm"
]
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"llmProviderConfigIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"defaultHeaders": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"name",
"baseUrlByEnvironment",
"authProfileIdByEnvironment"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runtimeKind": {
"type": "string",
"enum": [
"http",
"llm"
]
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"defaultHeaders": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"runtimeKind",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"defaultHeaders",
"createdAt",
"updatedAt"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴connection_update(name, description, runtimeKind, baseUrlByEnvironment, authProfileIdByEnvironment, ...)
Update an upstream connection using safe configuration and auth-profile references.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"runtimeKind": {
"default": "http",
"type": "string",
"enum": [
"http",
"llm"
]
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"llmProviderConfigIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"defaultHeaders": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"name",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runtimeKind": {
"type": "string",
"enum": [
"http",
"llm"
]
},
"baseUrlByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"authProfileIdByEnvironment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"defaultHeaders": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"runtimeKind",
"baseUrlByEnvironment",
"authProfileIdByEnvironment",
"defaultHeaders",
"createdAt",
"updatedAt"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢deployment_list(apiId)
List deployment environments and their states for an API.
Input Schema
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"enum": [
"dev",
"test",
"prod"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"activeVersion": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"changelog",
"createdAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"deployability": {
"type": "object",
"properties": {
"candidateSource": {
"type": "string",
"enum": [
"draft",
"dev",
"test",
"none"
]
},
"candidateVersion": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"changelog",
"createdAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"differsFromCurrent": {
"type": "boolean"
},
"eligible": {
"type": "boolean"
},
"reason": {
"type": "string",
"enum": [
"ready",
"project_not_editable",
"environment_disabled",
"draft_missing",
"draft_invalid",
"no_changes",
"source_environment_empty",
"already_current"
]
}
},
"required": [
"candidateSource",
"candidateVersion",
"differsFromCurrent",
"eligible",
"reason"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"status",
"activeVersion",
"deployability"
],
"additionalProperties": false
}
}
},
"required": [
"result"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢deployment_get_state(apiId)
Get full deployment state including environments and rollback targets for an API.
Input Schema
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"environments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"enum": [
"dev",
"test",
"prod"
]
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"activeVersion": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"changelog",
"createdAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"deployability": {
"type": "object",
"properties": {
"candidateSource": {
"type": "string",
"enum": [
"draft",
"dev",
"test",
"none"
]
},
"candidateVersion": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"changelog",
"createdAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"differsFromCurrent": {
"type": "boolean"
},
"eligible": {
"type": "boolean"
},
"reason": {
"type": "string",
"enum": [
"ready",
"project_not_editable",
"environment_disabled",
"draft_missing",
"draft_invalid",
"no_changes",
"source_environment_empty",
"already_current"
]
}
},
"required": [
"candidateSource",
"candidateVersion",
"differsFromCurrent",
"eligible",
"reason"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"status",
"activeVersion",
"deployability"
],
"additionalProperties": false
}
},
"rollbackTargets": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"versionId": {
"type": "string"
},
"versionNumber": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastDeployedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"versionId",
"versionNumber",
"changelog",
"lastDeployedAt"
],
"additionalProperties": false
}
}
}
},
"required": [
"environments",
"rollbackTargets"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴deployment_deploy(changelog, apiId)
Deploy the current draft to the Dev environment.
Input Schema
{
"type": "object",
"properties": {
"changelog": {
"type": "string"
},
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"skipped": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴deployment_promote
Promote a version from one environment to the next supported environment (Dev to Test, Test to Prod).
Input Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"fromEnvironment": {
"type": "string",
"const": "dev"
},
"toEnvironment": {
"type": "string",
"const": "test"
}
},
"required": [
"apiId",
"fromEnvironment",
"toEnvironment"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
},
"fromEnvironment": {
"type": "string",
"const": "test"
},
"toEnvironment": {
"type": "string",
"const": "prod"
}
},
"required": [
"apiId",
"fromEnvironment",
"toEnvironment"
],
"additionalProperties": false
}
]
}Output Schema
{
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"message": {
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴deployment_rollback(environmentName, versionId, apiId)
Rollback an environment to a previous version.
Input Schema
{
"type": "object",
"properties": {
"environmentName": {
"type": "string",
"enum": [
"dev",
"test",
"prod"
]
},
"versionId": {
"type": "string",
"minLength": 1
},
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"environmentName",
"versionId",
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴deployment_undeploy(environmentName, apiId)
Undeploy an environment, disabling it.
Input Schema
{
"type": "object",
"properties": {
"environmentName": {
"type": "string",
"enum": [
"dev",
"test",
"prod"
]
},
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"environmentName",
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"versionNumber": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢deployment_history(apiId)
List deployment history for an API.
Input Schema
{
"type": "object",
"properties": {
"apiId": {
"type": "string",
"minLength": 1
}
},
"required": [
"apiId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"deploy",
"rollback",
"undeploy"
]
},
"environmentName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"versionNumber": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"changelog": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"occurredAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"environmentName",
"versionNumber",
"changelog",
"occurredAt"
],
"additionalProperties": false
}
}
},
"required": [
"result"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Evidence
Recent observations
verifiedversion not recorded27 tools