shipsec-studio-api API reference · SKMTC Hub

/

/ShipSec Studio API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

Checked 8m ago · Updated 4w ago

cc60562ad9f3

latestOpenAPI 3.0.02026-07-1715378310.4 KB

agents2

get/api/v1/agents/{agentRunId}/parts
post/api/v1/agents/{agentRunId}/chat

analytics4

post/api/v1/analytics/query
get/api/v1/analytics/settings
put/api/v1/analytics/settings
post/api/v1/analytics/ensure-tenant

api-keys6

get/api/v1/api-keys
post/api/v1/api-keys
get/api/v1/api-keys/{id}
delete/api/v1/api-keys/{id}
patch/api/v1/api-keys/{id}
post/api/v1/api-keys/{id}/revoke

App4

get/api/v1/health
get/api/v1/auth/validate
post/api/v1/auth/login
post/api/v1/auth/logout

artifacts3

get/api/v1/artifacts
get/api/v1/artifacts/{id}/download
delete/api/v1/artifacts/{id}

audit-logs1

get/api/v1/audit-logs

components3

get/api/v1/components
get/api/v1/components/{id}
post/api/v1/components/{id}/resolve-ports

files5

post/api/v1/files/upload
get/api/v1/files
get/api/v1/files/{id}
delete/api/v1/files/{id}
get/api/v1/files/{id}/download

Human Inputs4

getList human input requests
getGet a human input request details
postResolve a human input request
postResolve input via public token

integrations10

get/api/v1/integrations/providers
get/api/v1/integrations/providers/{provider}/config
put/api/v1/integrations/providers/{provider}/config
delete/api/v1/integrations/providers/{provider}/config
get/api/v1/integrations/connections
post/api/v1/integrations/{provider}/start
post/api/v1/integrations/{provider}/exchange
post/api/v1/integrations/connections/{id}/refresh
delete/api/v1/integrations/connections/{id}
post/api/v1/integrations/connections/{id}/token

InternalMcp6

post/api/v1/internal/mcp/generate-token
post/api/v1/internal/mcp/register-component
post/api/v1/internal/mcp/register-mcp-server
post/api/v1/internal/mcp/cleanup
post/api/v1/internal/mcp/tools-ready
post/api/v1/internal/mcp/register-group-server

InternalRuns1

post/api/v1/internal/runs

mcp11

getUnified MCP Gateway endpoint (Streamable HTTP)
putUnified MCP Gateway endpoint (Streamable HTTP)
postUnified MCP Gateway endpoint (Streamable HTTP)
deleteUnified MCP Gateway endpoint (Streamable HTTP)
optionsUnified MCP Gateway endpoint (Streamable HTTP)
headUnified MCP Gateway endpoint (Streamable HTTP)
patchUnified MCP Gateway endpoint (Streamable HTTP)
postStart MCP tool discovery
getGet MCP discovery status
postStart MCP group tool discovery
getGet MCP group discovery status

mcp-groups13

getList all MCP groups
postCreate a new MCP group (admin only)
getList available MCP group templates
getGet a group by slug
getGet a specific MCP group
deleteDelete an MCP group (admin only)
patchUpdate an MCP group
getGet servers in a group
postAdd a server to a group (admin only)
deleteRemove a server from a group (admin only)
patchUpdate server metadata in a group (admin only)
postSync group templates from code (admin only)
postImport a group template (admin only)

mcp-servers13

getList all MCP servers
postCreate a new MCP server configuration
getList enabled MCP servers only
getList all tools from enabled MCP servers
getGet health status of all enabled servers
getGet a specific MCP server
deleteDelete an MCP server configuration
patchUpdate an MCP server configuration
getList discovered tools from a server
postToggle MCP server enabled/disabled status
postTest connection to an MCP server
postToggle a tool enabled/disabled state
getGet resolved MCP server configuration (with secrets resolved)

Schedules8

get/api/v1/schedules
post/api/v1/schedules
get/api/v1/schedules/{id}
delete/api/v1/schedules/{id}
patch/api/v1/schedules/{id}
post/api/v1/schedules/{id}/pause
post/api/v1/schedules/{id}/resume
post/api/v1/schedules/{id}/trigger

secrets7

get/api/v1/secrets
post/api/v1/secrets
get/api/v1/secrets/{id}
delete/api/v1/secrets/{id}
patch/api/v1/secrets/{id}
get/api/v1/secrets/{id}/value
put/api/v1/secrets/{id}/rotate

TestingWebhook5

get/api/v1/testing/webhooks
post/api/v1/testing/webhooks
delete/api/v1/testing/webhooks
get/api/v1/testing/webhooks/latest
get/api/v1/testing/webhooks/{id}

webhooks17

get/api/v1/webhooks/workflows
get/api/v1/webhooks/workflows/{id}
post/api/v1/webhooks/workflows/{id}/run
get/api/v1/webhooks/runs/{runId}/status
get/api/v1/webhooks/runs/{runId}/result
post/api/v1/webhooks/runs/{runId}/cancel
postReceive inbound webhook
getList all webhook configurations
postCreate a new webhook configuration
getGet a webhook configuration by ID
putUpdate a webhook configuration
deleteDelete a webhook configuration
postRegenerate webhook path (creates new URL)
getGet the webhook URL for a configuration
postTest a parsing script with sample data
getList delivery history for a webhook
getGet details of a specific delivery

workflows30

get/api/v1/workflows
post/api/v1/workflows
get/api/v1/workflows/{id}
put/api/v1/workflows/{id}
delete/api/v1/workflows/{id}
patch/api/v1/workflows/{id}/metadata
get/api/v1/workflows/runs
get/api/v1/workflows/runs/{runId}
get/api/v1/workflows/runs/{runId}/children
get/api/v1/workflows/{id}/runtime-inputs
get/api/v1/workflows/{workflowId}/versions/{versionId}
post/api/v1/workflows/{id}/commit
post/api/v1/workflows/{id}/run
get/api/v1/workflows/runs/{runId}/status
get/api/v1/workflows/runs/{runId}/result
get/api/v1/workflows/runs/{runId}/config
post/api/v1/workflows/runs/{runId}/cancel
get/api/v1/workflows/runs/{runId}/trace
get/api/v1/workflows/runs/{runId}/events
get/api/v1/workflows/runs/{runId}/dataflows
get/api/v1/workflows/runs/{runId}/artifacts
get/api/v1/workflows/runs/{runId}/artifacts/{artifactId}/download
get/api/v1/workflows/runs/{runId}/node-io
get/api/v1/workflows/runs/{runId}/node-io/{nodeRef}
get/api/v1/workflows/runs/{runId}/stream
get/api/v1/workflows/runs/{runId}/logs
get/api/v1/workflows/runs/{runId}/terminal
get/api/v1/workflows/runs/{runId}/terminal/archive
post/api/v1/workflows/runs/{runId}/terminal/archive
get/api/v1/workflows/runs/{runId}/terminal/archive/{recordId}/download

App

get/api/v1/health