API overview

The synsmarts API is the supported automation interface for customer operations. Use this overview for the API contract and authentication model, then open the interactive reference for request fields, response schemas, and language-specific examples.

Open the interactive reference

Download OpenAPI JSON

API and portal parity

The portal and public API expose customer capabilities through different adapters:

• The portal uses a browser session and CSRF protection.
• The public API uses an App-bound API key or a supported delegated bearer token.
• The CLI is a peer client of the public API for operations that have a CLI mapping.

Parity means a customer capability can be available through the portal, API, and CLI through the same Team/App resource address, with each client using its own authentication method. It doesn’t mean every published API operation is already presented in every client. The generated availability shown for each operation below is authoritative for the portal and CLI. The generated OpenAPI document is authoritative for direct API access. If an operation isn’t listed below, it isn’t currently published for customer API use.

Base URL and version

https://api.synsmarts.io

All paths are relative to this URL. The current contract uses versioned /api/v1/ paths. Validate requests and responses against the published schema; breaking contract changes use a new API version.

Authentication

Send an App-bound API key in the X-API-Key header. A bearer token issued by synsmarts can also authenticate supported integrations. Every customer operation addresses its Team at /api/v1/t/{team}/...; App operations continue through /a/{app}/.... The path selects the resource. The session, API key, or delegated grant authorizes access to that addressed resource.

Don’t put credentials in a URL, query string, source repository, or support attachment.

API key example

curl --request GET \
  --url "https://api.synsmarts.io/api/v1/t/$TEAM/a/$APP/diagnostics" \
  --header "Accept: application/json" \
  --header "X-API-Key: $SYNSMARTS_API_KEY"

Store the key in a secret manager or protected environment variable. Create a separate key for each integration so it can be rotated or revoked independently.

Errors

Errors use application/problem+json with stable fields including status, detail, and error_code. Respect Retry-After when it is present on a 429 or 503 response. Otherwise, use the HTTP status and operation behavior to decide whether a retry is safe.

Published operations

Most published operations are App-scoped. Scope: app means the operation is addressed by its /a/{app}/ path segment, and the credential authorizes access to that App. An App-bound key authorizes only its own App. Scope: team means the operation is addressed by its /t/{team}/ path segment, and the credential authorizes access to that Team. Request-tracing operations are the exception, and their team_slug and tenant_id are validated against the caller. synchronous operations complete in the response. A durable operation accepts work for continued processing and returns the identifier named in its completion metadata; save that identifier for the related status or result operation.

Deployments

Deploy application releases, inspect deployment status and history, and roll back releases.

Deploy

POST /api/v1/t/{team}/a/{app}/deploys/create

Operation ID: deployment.deploy

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: deployments.write · Completion: durable; save deploy_id from the response

Portal: Shown as Deploy
CLI: Presented as deploy trigger

View request fields, response schemas, and code samples →

Deployment status

GET /api/v1/t/{team}/a/{app}/deploys/{deploy_id}

Operation ID: deployment.getStatus

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: operations.read · Completion: synchronous

Portal: Shown as Deployment status
CLI: Presented as deploy status

View request fields, response schemas, and code samples →

Roll back deployment

POST /api/v1/t/{team}/a/{app}/deploys/{deploy_id}/rollback

Operation ID: deployment.rollback

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: deployments.write · Completion: durable; save deploy_id from the response

Portal: Shown as Roll back deployment
CLI: Presented as deploy rollback

View request fields, response schemas, and code samples →

Deployment history

GET /api/v1/t/{team}/a/{app}/deploys

Operation ID: diagnostics.getDeployHistory

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: deployments.read · Completion: synchronous

Portal: Shown as Deployment history
CLI: Presented as deploy list

View request fields, response schemas, and code samples →

Diagnostics

Run investigations and inspect reports, telemetry, traces, configuration, queries, and code.

Explain query

POST /api/v1/t/{team}/a/{app}/diagnostics/explain

Operation ID: diagnostics.explainQuery

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Analysis-only; leaves App configuration unchanged.

Scope: app · Permission: database_queries.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as mysql explain

View request fields, response schemas, and code samples →

Get configuration

GET /api/v1/t/{team}/a/{app}/diagnostics/config/{service}

Operation ID: diagnostics.getConfig

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: config.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as diagnostics config

View request fields, response schemas, and code samples →

Diagnostic report

GET /api/v1/t/{team}/a/{app}/diagnostics/{investigation_id}/report

Operation ID: diagnostics.getReport

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: findings.read · Completion: synchronous

Portal: Shown as Diagnostic report
CLI: Presented as diagnostics report

View request fields, response schemas, and code samples →

Trace detail

GET /api/v1/t/{team}/a/{app}/diagnostics/traces/{trace_id}

Operation ID: diagnostics.getTraceDetail

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: traces.read · Completion: synchronous

Portal: Shown as Trace detail
CLI: Presented as traces show

View request fields, response schemas, and code samples →

Diagnostic investigations

GET /api/v1/t/{team}/a/{app}/diagnostics

Operation ID: diagnostics.listInvestigations

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: findings.read · Completion: synchronous

Portal: Shown as Diagnostic investigations
CLI: Presented as diagnostics list

View request fields, response schemas, and code samples →

Query logs

GET /api/v1/t/{team}/a/{app}/diagnostics/logs

Operation ID: diagnostics.queryLogs

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: logs.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as logs

View request fields, response schemas, and code samples →

Query metrics

GET /api/v1/t/{team}/a/{app}/diagnostics/metrics

Operation ID: diagnostics.queryMetrics

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: metrics.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as metrics

View request fields, response schemas, and code samples →

Trace summaries

GET /api/v1/t/{team}/a/{app}/diagnostics/traces

Operation ID: diagnostics.queryTraces

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: traces.read · Completion: synchronous

Portal: Shown as Trace summaries
CLI: Presented as traces list

View request fields, response schemas, and code samples →

Apply recommendation

POST /api/v1/t/{team}/a/{app}/diagnostics/recommendations/{rec_id}/apply

Operation ID: diagnostics.recommendations.apply

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: recommendations.write · Completion: durable; save operation_id from the response

Portal: Shown as Apply recommendation
CLI: Presented as recommendations apply

View request fields, response schemas, and code samples →

Dismiss recommendation

POST /api/v1/t/{team}/a/{app}/diagnostics/recommendations/{rec_id}/dismiss

Operation ID: diagnostics.recommendations.dismiss

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: recommendations.write · Completion: synchronous

Portal: Shown as Dismiss recommendation
CLI: Presented as recommendations dismiss

View request fields, response schemas, and code samples →

Recommendation detail

GET /api/v1/t/{team}/a/{app}/diagnostics/recommendations/{rec_id}

Operation ID: diagnostics.recommendations.get

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: findings.read · Completion: synchronous

Portal: Shown as Recommendation detail
CLI: Presented as recommendations show

View request fields, response schemas, and code samples →

Recommendations

GET /api/v1/t/{team}/a/{app}/diagnostics/recommendations

Operation ID: diagnostics.recommendations.list

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: findings.read · Completion: synchronous

Portal: Shown as Recommendations
CLI: Presented as recommendations list

View request fields, response schemas, and code samples →

Mark recommendation applied

POST /api/v1/t/{team}/a/{app}/diagnostics/recommendations/{rec_id}/mark-applied

Operation ID: diagnostics.recommendations.markApplied

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: recommendations.write · Completion: synchronous

Portal: Shown as Mark recommendation applied
CLI: Presented as recommendations mark-applied

View request fields, response schemas, and code samples →

Mark recommendation not applied

POST /api/v1/t/{team}/a/{app}/diagnostics/recommendations/{rec_id}/mark-not-applied

Operation ID: diagnostics.recommendations.markNotApplied

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: recommendations.write · Completion: synchronous

Portal: Shown as Mark recommendation not applied
CLI: Presented as recommendations mark-not-applied

View request fields, response schemas, and code samples →

Reopen recommendation

POST /api/v1/t/{team}/a/{app}/diagnostics/recommendations/{rec_id}/reopen

Operation ID: diagnostics.recommendations.reopen

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: recommendations.write · Completion: synchronous

Portal: Shown as Reopen recommendation
CLI: Presented as recommendations reopen

View request fields, response schemas, and code samples →

Search code

GET /api/v1/t/{team}/a/{app}/diagnostics/code/search

Operation ID: diagnostics.searchCode

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: code.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as code search

View request fields, response schemas, and code samples →

Run diagnostics

POST /api/v1/t/{team}/a/{app}/diagnostics/trigger

Operation ID: diagnostics.triggerInvestigation

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Analysis-only; leaves App configuration unchanged.

Scope: app · Permission: diagnostics.run · Completion: durable; save investigation_id from the response

Portal: Shown as Run diagnostics
CLI: Presented as diagnostics run

View request fields, response schemas, and code samples →

Service operations

Inspect and operate App services and reconcile customer configuration.

Clear cache

POST /api/v1/t/{team}/a/{app}/services/cache/clear

Operation ID: control.clearCache

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: services.operate · Completion: durable; save action_id from the response

Portal: Shown as Clear cache
CLI: Presented as services clear-cache

View request fields, response schemas, and code samples →

Configure services

POST /api/v1/t/{team}/a/{app}/site-configuration

Operation ID: control.configureServices

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: config.write · Completion: durable; save deployment_id from the response

Portal: Shown as Configure services
CLI: Presented as config apply

View request fields, response schemas, and code samples →

Create certificate request

POST /api/v1/t/{team}/a/{app}/dns/certificates/csr

Operation ID: control.createDomainCertificateRequest

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation.

Scope: app · Permission: config.write · Completion: synchronous

Portal: Shown as Create certificate request
CLI: Presented as dns certificate-request

View request fields, response schemas, and code samples →

Disable cron

POST /api/v1/t/{team}/a/{app}/services/cron/disable

Operation ID: control.disableCron

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: services.operate · Completion: durable; save action_id from the response

Portal: Shown as Disable cron
CLI: Presented as services cron

View request fields, response schemas, and code samples →

Flush OPcache

POST /api/v1/t/{team}/a/{app}/services/opcache/flush

Operation ID: control.flushOpcache

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: services.operate · Completion: durable; save action_id from the response

Portal: Shown as Flush OPcache
CLI: Presented as services flush-opcache

View request fields, response schemas, and code samples →

Action status

GET /api/v1/t/{team}/a/{app}/services/status/{action_id}

Operation ID: control.getActionStatus

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: operations.read · Completion: synchronous

Portal: Shown as Action status
CLI: Presented as services status

View request fields, response schemas, and code samples →

Magento 1 settings

GET /api/v1/t/{team}/a/{app}/config/magento1

Operation ID: control.getMagento1Settings

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: config.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as deploy config-magento1-show

View request fields, response schemas, and code samples →

Site configuration

GET /api/v1/t/{team}/a/{app}/site-configuration

Operation ID: control.getSiteConfiguration

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: config.read · Completion: synchronous

Portal: Shown as Site configuration
CLI: Presented as config show

View request fields, response schemas, and code samples →

Kill database query

POST /api/v1/t/{team}/a/{app}/services/mysql/kill-query

Operation ID: control.killQuery

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: database_queries.terminate · Completion: durable; save action_id from the response

Portal: Shown as Kill database query
CLI: Presented as mysql kill

View request fields, response schemas, and code samples →

Preview configuration

POST /api/v1/t/{team}/a/{app}/config/preview

Operation ID: control.previewConfiguration

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Analysis-only; leaves App configuration unchanged.

Scope: app · Permission: config.read · Completion: synchronous

Portal: Shown as Preview configuration
CLI: Presented as config preview

View request fields, response schemas, and code samples →

Reapply committed configuration

POST /api/v1/t/{team}/a/{app}/config/reconcile

Operation ID: control.reconcileConfiguration

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: config.write · Completion: durable; save deployment_id from the response

Portal: Not currently presented
CLI: Presented as deploy config-reconcile

View request fields, response schemas, and code samples →

Remove certificate

DELETE /api/v1/t/{team}/a/{app}/dns/domains/{name}/certificate

Operation ID: control.removeDomainCertificate

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation.

Scope: app · Permission: config.write · Completion: synchronous

Portal: Shown as Remove certificate
CLI: Presented as dns certificate-remove

View request fields, response schemas, and code samples →

Restart PHP

POST /api/v1/t/{team}/a/{app}/services/php/restart

Operation ID: control.restartPhp

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: services.operate · Completion: durable; save action_id from the response

Portal: Shown as Restart PHP
CLI: Presented as services restart-php

View request fields, response schemas, and code samples →

Restart Redis

POST /api/v1/t/{team}/a/{app}/services/redis/restart

Operation ID: control.restartRedis

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: services.operate · Completion: durable; save action_id from the response

Portal: Shown as Restart Redis
CLI: Presented as services restart-redis

View request fields, response schemas, and code samples →

Roll back configuration

POST /api/v1/t/{team}/a/{app}/config/rollback

Operation ID: control.rollbackConfiguration

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: config.write · Completion: durable; save operation_id from the response

Portal: Shown as Roll back configuration
CLI: Presented as config rollback

View request fields, response schemas, and code samples →

Scale resources

POST /api/v1/t/{team}/a/{app}/services/scale

Operation ID: control.scale

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: scale.write · Completion: durable; save action_id from the response

Portal: Shown as Scale resources
CLI: Presented as services scale

View request fields, response schemas, and code samples →

Hide from search engines

PUT /api/v1/t/{team}/a/{app}/dns/domains/{name}/search-visibility

Operation ID: control.setDomainSearchVisibility

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation.

Scope: app · Permission: config.write · Completion: synchronous

Portal: Shown as Hide from search engines
CLI: Presented as deploy domain-search-visibility

View request fields, response schemas, and code samples →

Toggle maintenance mode

POST /api/v1/t/{team}/a/{app}/services/maintenance/toggle

Operation ID: control.toggleMaintenanceMode

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires confirmed: true and an Idempotency-Key.

Scope: app · Permission: services.operate · Completion: durable; save action_id from the response

Portal: Shown as Toggle maintenance mode
CLI: Presented as services maintenance

View request fields, response schemas, and code samples →

Update Magento 1 settings

PUT /api/v1/t/{team}/a/{app}/config/magento1

Operation ID: control.updateMagento1Settings

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation.

Scope: app · Permission: config.write · Completion: synchronous

Portal: Not currently presented
CLI: Presented as deploy config-magento1

View request fields, response schemas, and code samples →

Upload certificate

POST /api/v1/t/{team}/a/{app}/dns/certificates

Operation ID: control.uploadDomainCertificate

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation.

Scope: app · Permission: config.write · Completion: synchronous

Portal: Shown as Upload certificate
CLI: Presented as dns certificate-upload

View request fields, response schemas, and code samples →

Validate configuration

POST /api/v1/t/{team}/a/{app}/config/validate

Operation ID: control.validateConfiguration

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Analysis-only; leaves App configuration unchanged.

Scope: app · Permission: config.read · Completion: synchronous

Portal: Shown as Validate configuration
CLI: Presented as config validate

View request fields, response schemas, and code samples →

Database connections

GET /api/v1/t/{team}/a/{app}/services/mysql/connections

Operation ID: control.viewConnections

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: database_queries.read · Completion: synchronous

Portal: Shown as Database connections
CLI: Presented as mysql connections

View request fields, response schemas, and code samples →

Billing

Read team-scoped usage and invoices.

Invoice detail

GET /api/v1/t/{team}/billing/invoices/{invoice_id}

Operation ID: billing.getInvoice

Scoped to the addressed Team; the {team} path segment selects the resource and the credential authorizes access. Read-only.

Scope: team · Permission: billing.read · Completion: synchronous

Portal: Shown as Invoice detail
CLI: Presented as billing invoice

View request fields, response schemas, and code samples →

Billing usage

GET /api/v1/t/{team}/billing/usage

Operation ID: billing.getUsage

Scoped to the addressed Team; the {team} path segment selects the resource and the credential authorizes access. Read-only.

Scope: team · Permission: billing.read · Completion: synchronous

Portal: Shown as Billing usage
CLI: Presented as billing usage

View request fields, response schemas, and code samples →

Invoices

GET /api/v1/t/{team}/billing/invoices

Operation ID: billing.listInvoices

Scoped to the addressed Team; the {team} path segment selects the resource and the credential authorizes access. Read-only.

Scope: team · Permission: billing.read · Completion: synchronous

Portal: Shown as Invoices
CLI: Presented as billing invoices

View request fields, response schemas, and code samples →

Environments

Inspect environments and purchased resource allocations.

Resources

GET /api/v1/t/{team}/a/{app}/resources

Operation ID: environment.getResources

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: config.read · Completion: synchronous

Portal: Shown as Resources
CLI: Presented as resources

View request fields, response schemas, and code samples →

Environments

GET /api/v1/t/{team}/a/{app}/environments

Operation ID: environment.list

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: operations.read · Completion: synchronous

Portal: Shown as Environments
CLI: Presented as environments

View request fields, response schemas, and code samples →

Live status

Read live runtime status and service information for an App.

App status

GET /api/v1/t/{team}/a/{app}

Operation ID: app.get

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: status.read · Completion: synchronous

Portal: Shown as App status
CLI: Presented as status

View request fields, response schemas, and code samples →

MySQL variables

GET /api/v1/t/{team}/a/{app}/live/mysql/variables

Operation ID: live.getMysqlVariables

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: status.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as live mysql-variables

View request fields, response schemas, and code samples →

Nginx status

GET /api/v1/t/{team}/a/{app}/live/nginx/status

Operation ID: live.getNginxStatus

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: status.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as live nginx

View request fields, response schemas, and code samples →

PHP-FPM status

GET /api/v1/t/{team}/a/{app}/live/php-fpm/status

Operation ID: live.getPhpFpmStatus

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: status.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as live php-fpm

View request fields, response schemas, and code samples →

PHP information

GET /api/v1/t/{team}/a/{app}/live/php/info

Operation ID: live.getPhpInfo

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: status.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as live php-info

View request fields, response schemas, and code samples →

Redis information

GET /api/v1/t/{team}/a/{app}/live/redis/info

Operation ID: live.getRedisInfo

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: status.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as live redis

View request fields, response schemas, and code samples →

Audit

Read customer-visible audit events for an App.

Audit events

GET /api/v1/t/{team}/a/{app}/audit-events

Operation ID: audit.getEvents

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: audit.read · Completion: synchronous

Portal: Shown as Audit events
CLI: Presented as audit

View request fields, response schemas, and code samples →

Backups

List available backups for an App.

Backups

GET /api/v1/t/{team}/a/{app}/backups

Operation ID: backups.list

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: backups.read · Completion: synchronous

Portal: Shown as Backups
CLI: Presented as backups list

View request fields, response schemas, and code samples →

DNS & TLS

Inspect App domain, DNS, and TLS status.

DNS and TLS status

GET /api/v1/t/{team}/a/{app}/dns

Operation ID: dnsTls.getDomains

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: dns_tls.read · Completion: synchronous

Portal: Shown as DNS and TLS status
CLI: Presented as dns list

View request fields, response schemas, and code samples →

Request tracing

Read and update resource-addressed request tracing.

Get request tracing configuration

GET /api/v1/t/{team}/a/{app}/tracing

Operation ID: tracing.getConfiguration

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: config.read · Completion: synchronous

Portal: Shown as Request tracing configuration
CLI: Presented as tracing show

View request fields, response schemas, and code samples →

Update request tracing configuration

PUT /api/v1/t/{team}/a/{app}/tracing

Operation ID: tracing.updateConfiguration

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation.

Scope: app · Permission: config.write · Completion: synchronous

Portal: Shown as Update request tracing configuration
CLI: Presented as tracing set

View request fields, response schemas, and code samples →

Support tickets

List, read, and search the Team’s support tickets.

Support tickets

GET /api/v1/t/{team}/tickets/

Operation ID: tickets.collection

Scoped to the addressed Team; the {team} path segment selects the resource and the credential authorizes access. Read-only.

Scope: team · Permission: support.read · Completion: synchronous

Portal: Shown as Support tickets
CLI: Presented as tickets list

View request fields, response schemas, and code samples →

Support ticket

GET /api/v1/t/{team}/tickets/{ticket_uuid}/

Operation ID: tickets.detail

Scoped to the addressed Team; the {team} path segment selects the resource and the credential authorizes access. Read-only.

Scope: team · Permission: support.read · Completion: synchronous

Portal: Shown as Support ticket
CLI: Presented as tickets show

View request fields, response schemas, and code samples →

Search support tickets

GET /api/v1/teams/{team}/tickets/search

Operation ID: tickets.search

Scoped to the addressed Team; the {team} path segment selects the resource and the credential authorizes access. Read-only.

Scope: team · Permission: support.read · Completion: synchronous

Portal: Not currently presented
CLI: Presented as tickets search

View request fields, response schemas, and code samples →

SSH access

Manage an App’s managed-shell SSH users, their public keys, and the source IP allowlist.

Allow a source IP range

POST /api/v1/t/{team}/a/{app}/ssh/allowlist/add

Operation ID: ssh.addAllowlistEntry

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: ssh.allowlist.write · Completion: synchronous

Portal: Shown as Allow a source IP range
CLI: Presented as ssh allowlist add

View request fields, response schemas, and code samples →

Add an SSH public key

POST /api/v1/t/{team}/a/{app}/ssh/users/{user_id}/keys/add

Operation ID: ssh.addKey

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: ssh.write · Completion: synchronous

Portal: Shown as Add an SSH public key
CLI: Presented as ssh keys add

View request fields, response schemas, and code samples →

Add an SSH user

POST /api/v1/t/{team}/a/{app}/ssh/users/create

Operation ID: ssh.createUser

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: ssh.write · Completion: synchronous

Portal: Shown as Add an SSH user
CLI: Presented as ssh users create

View request fields, response schemas, and code samples →

SSH IP allowlist

GET /api/v1/t/{team}/a/{app}/ssh/allowlist/

Operation ID: ssh.listAllowlist

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: ssh.read · Completion: synchronous

Portal: Shown as SSH IP allowlist
CLI: Presented as ssh allowlist list

View request fields, response schemas, and code samples →

SSH users

GET /api/v1/t/{team}/a/{app}/ssh/users/

Operation ID: ssh.listUsers

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Read-only.

Scope: app · Permission: ssh.read · Completion: synchronous

Portal: Shown as SSH users
CLI: Presented as ssh users list

View request fields, response schemas, and code samples →

Remove a source IP range

POST /api/v1/t/{team}/a/{app}/ssh/allowlist/{entry_id}/remove

Operation ID: ssh.removeAllowlistEntry

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: ssh.allowlist.write · Completion: synchronous

Portal: Shown as Remove a source IP range
CLI: Presented as ssh allowlist remove

View request fields, response schemas, and code samples →

Remove an SSH user

POST /api/v1/t/{team}/a/{app}/ssh/users/{user_id}/remove

Operation ID: ssh.removeUser

Scoped to the addressed App; the {team} and {app} path segments select the resource and the credential authorizes access. MCP tools supply their app_id through the canonical App path segment. Mutating operation; requires an Idempotency-Key.

Scope: app · Permission: ssh.write · Completion: synchronous

Portal: Shown as Remove an SSH user
CLI: Presented as ssh users remove

View request fields, response schemas, and code samples →

The operation list and interactive reference are generated from the same canonical capability catalog. Publishing a customer operation updates both without maintaining a separate handwritten endpoint inventory.

---

Contract catalog version: 1
Contract digest: 9ca756a4e7c505084c35fcfcec65103c72267a42044ab30cf5438d6d77f24e82