api.md

Health

Types:

• HealthCheckResponse

Methods:

• client.health.check() -> HealthCheckResponse

Servers

Types:

• BuildConfig
• DeploymentTarget
• ProjectConfig
• ServerCreateResponse
• ServerUpdateResponse
• ServerListResponse
• ServerDeleteResponse
• ServerGetResponse

Methods:

• client.servers.create(qualifiedName, { ...params }) -> ServerCreateResponse
• client.servers.update(qualifiedName, { ...params }) -> ServerUpdateResponse
• client.servers.list({ ...params }) -> ServerListResponsesSmitheryPage
• client.servers.delete(qualifiedName) -> ServerDeleteResponse
• client.servers.download(qualifiedName) -> Response
• client.servers.get(qualifiedName) -> ServerGetResponse

Releases

Types:

• DeployPayload
• ExternalDeployPayload
• HostedDeployPayload
• ServerCard
• ReleaseListResponse
• ReleaseDeployResponse
• ReleaseGetResponse
• ReleaseResumeResponse
• ReleaseStreamResponse

Methods:

• client.servers.releases.list(qualifiedName, { ...params }) -> ReleaseListResponsesReleasesPage
• client.servers.releases.deploy(qualifiedName, { ...params }) -> ReleaseDeployResponse
• client.servers.releases.get(id, { ...params }) -> ReleaseGetResponse
• client.servers.releases.resume(id, { ...params }) -> ReleaseResumeResponse
• client.servers.releases.stream(id, { ...params }) -> string

Logs

Types:

• LogListResponse

Methods:

• client.servers.logs.list(qualifiedName, { ...params }) -> LogListResponse

Secrets

Types:

• SecretListResponse
• SecretDeleteResponse
• SecretSetResponse

Methods:

• client.servers.secrets.list(qualifiedName) -> SecretListResponse
• client.servers.secrets.delete(secretName, { ...params }) -> SecretDeleteResponse
• client.servers.secrets.set(qualifiedName, { ...params }) -> SecretSetResponse

Icon

Types:

• IconDeleteResponse
• IconUploadResponse

Methods:

• client.servers.icon.delete(qualifiedName) -> IconDeleteResponse
• client.servers.icon.get(qualifiedName) -> Response
• client.servers.icon.upload(qualifiedName) -> IconUploadResponse

Domains

Types:

• DomainUpdateResponse
• DomainListResponse

Methods:

• client.servers.domains.update(domainID, { ...params }) -> DomainUpdateResponse
• client.servers.domains.list(qualifiedName) -> DomainListResponse

Skills

Types:

• SkillCreateResponse
• SkillListResponse
• SkillDeleteResponse
• SkillGetResponse
• SkillSetResponse
• SkillSyncResponse
• SkillUploadResponse

Methods:

• client.skills.create({ ...params }) -> SkillCreateResponse
• client.skills.list({ ...params }) -> SkillListResponsesSkillsPage
• client.skills.delete(slug, { ...params }) -> SkillDeleteResponse
• client.skills.download(slug, { ...params }) -> Response
• client.skills.get(slug, { ...params }) -> SkillGetResponse
• client.skills.set(slug, { ...params }) -> SkillSetResponse
• client.skills.sync(slug, { ...params }) -> SkillSyncResponse
• client.skills.upload(slug, { ...params }) -> SkillUploadResponse

Namespaces

Types:

• NamespaceCreateResponse
• NamespaceListResponse
• NamespaceDeleteResponse
• NamespaceSetResponse

Methods:

• client.namespaces.create() -> NamespaceCreateResponse
• client.namespaces.list({ ...params }) -> NamespaceListResponsesNamespacesPage
• client.namespaces.delete(name) -> NamespaceDeleteResponse
• client.namespaces.set(name) -> NamespaceSetResponse

Servers

Types:

• ServerCreateResponse

Methods:

• client.namespaces.servers.create(server, { ...params }) -> ServerCreateResponse

Organizations

APIKeys

Types:

• APIKeyCreateResponse
• APIKeyListResponse
• APIKeyDeleteResponse

Methods:

• client.organizations.apiKeys.create(orgID, { ...params }) -> APIKeyCreateResponse
• client.organizations.apiKeys.list(orgID) -> APIKeyListResponse
• client.organizations.apiKeys.delete(keyID, { ...params }) -> APIKeyDeleteResponse

Tokens

Types:

• Constraint
• CreateTokenRequest
• CreateTokenResponse

Methods:

• client.tokens.create({ ...params }) -> CreateTokenResponse

Connections

Types:

• Connection
• ConnectionsListResponse
• CreateConnectionRequest
• ConnectionDeleteResponse

Methods:

• client.connections.create(namespace, { ...params }) -> Connection
• client.connections.list(namespace, { ...params }) -> ConnectionsListResponse
• client.connections.delete(connectionID, { ...params }) -> ConnectionDeleteResponse
• client.connections.get(connectionID, { ...params }) -> Connection
• client.connections.set(connectionID, { ...params }) -> Connection

Tools

Types:

• Tool
• ToolList
• ToolResponse
• ToolCallResponse

Methods:

• client.connections.tools.list(connectionID, { ...params }) -> ToolList
• client.connections.tools.call(toolPath, { ...params }) -> ToolCallResponse
• client.connections.tools.get(toolPath, { ...params }) -> ToolResponse

Triggers

Types:

• CreateTriggerRequest
• DeleteTriggerRequest
• TriggerDefinition
• TriggerDefinitionList
• TriggerDelivery
• TriggerSubscription
• UnsubscribeDelivery
• TriggerUnsubscribeResponse

Methods:

• client.connections.triggers.list(connectionID, { ...params }) -> TriggerDefinitionList
• client.connections.triggers.get(triggerName, { ...params }) -> TriggerDefinition
• client.connections.triggers.subscribe(triggerName, { ...params }) -> TriggerSubscription
• client.connections.triggers.unsubscribe(triggerName, { ...params }) -> TriggerUnsubscribeResponse