User API

What this endpoint does

List accounts visible to current role.

Endpoint

GET /v1/accounts

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (0)

This endpoint accepts no path, query, or JSON parameters.

Complete request template

This reference template contains all 0 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "access_denied",
  "message": "The API key is not authorized for this endpoint, resource, role, or source IP."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Get account details by system username.

Endpoint

GET /v1/accounts/{username}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Fetch AI-ready API catalog batches with endpoint role, target scope, request fields, examples, and usage guidance. Catalog text is English reference data; the assistant should translate natural user intent into English search keywords and answer the user in the latest message language.

Endpoint

GET /v1/ai/catalog

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (8)

Complete request template

This reference template contains all 8 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {},
  "query_parameters": {
    "account": "demo",
    "allow_destructive": 1,
    "batch": 1,
    "batch_size": 1,
    "execute_read_post": 1,
    "q": "account",
    "role": "user",
    "surface": "account"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/ai/catalog?q=account&role=user&surface=account&account=demo' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {},
  "query_parameters": {
    "q": "account",
    "role": "user",
    "surface": "account",
    "account": "demo"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Fetch SHM account AI workspace context

Endpoint

GET /v1/accounts/{username}/ai/context

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/ai/context' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account AI conversations

Endpoint

GET /v1/accounts/{username}/ai/conversations

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/ai/conversations' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Create a SHM account AI conversation

Endpoint

POST /v1/accounts/{username}/ai/conversations

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/ai/conversations' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Delete an empty SHM account AI draft conversation

Endpoint

DELETE /v1/accounts/{username}/ai/conversations/{conversation_id}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "conversation_id": 1,
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X DELETE 'https://panel.example.com:882/v1/accounts/demo/ai/conversations/1' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "conversation_id": 1
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Load a SHM account AI conversation

Endpoint

GET /v1/accounts/{username}/ai/conversations/{conversation_id}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "conversation_id": 1,
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/ai/conversations/1' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "conversation_id": 1
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Save a SHM account AI conversation

Endpoint

PATCH /v1/accounts/{username}/ai/conversations/{conversation_id}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (7)

Complete request template

This reference template contains all 7 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "conversation_id": 1,
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "created_at": "2026-07-16",
    "model": "gpt-5.4",
    "provider": "openai",
    "title": "Example content",
    "updated_at": "2026-07-16"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X PATCH 'https://panel.example.com:882/v1/accounts/demo/ai/conversations/1' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"provider":"openai","model":"gpt-5.4","created_at":"2026-07-16","updated_at":"2026-07-16"}'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "conversation_id": 1
  },
  "query_parameters": {},
  "json_body": {
    "provider": "openai",
    "model": "gpt-5.4",
    "created_at": "2026-07-16",
    "updated_at": "2026-07-16"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Set the active SHM account AI conversation

Endpoint

PATCH /v1/accounts/{username}/ai/conversations/current

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "conversation_id": 1
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X PATCH 'https://panel.example.com:882/v1/accounts/demo/ai/conversations/current' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"conversation_id":1}'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "conversation_id": 1
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Set SHM account AI enabled state

Endpoint

PATCH /v1/accounts/{username}/ai/enabled

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "enabled": 1
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X PATCH 'https://panel.example.com:882/v1/accounts/demo/ai/enabled' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"enabled":1}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "enabled": 1
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Clear a SHM account AI API key

Endpoint

DELETE /v1/accounts/{username}/ai/keys/{provider}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Intentionally excluded from AI Mode. Provider credentials cannot be read, created, or deleted through chat.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "provider": "demo",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X DELETE 'https://panel.example.com:882/v1/accounts/demo/ai/keys/demo' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "provider": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Reveal a SHM account AI API key for external use

Endpoint

GET /v1/accounts/{username}/ai/keys/{provider}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Intentionally excluded from AI Mode. Provider credentials cannot be read, created, or deleted through chat.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "provider": "demo",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/ai/keys/demo' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "provider": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Save an encrypted SHM account AI API key

Endpoint

POST /v1/accounts/{username}/ai/keys/{provider}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Intentionally excluded from AI Mode. Provider credentials cannot be read, created, or deleted through chat.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "provider": "demo",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "api_key": "YOUR_API_KEY"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/ai/keys/demo' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"api_key":"YOUR_API_KEY"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "provider": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "api_key": "YOUR_API_KEY"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Set the SHM account AI model override

Endpoint

PATCH /v1/accounts/{username}/ai/models/{provider}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "provider": "demo",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "model": "gpt-5.4"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X PATCH 'https://panel.example.com:882/v1/accounts/demo/ai/models/demo' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"model":"gpt-5.4"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "provider": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "model": "gpt-5.4"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Set the SHM account AI provider

Endpoint

PATCH /v1/accounts/{username}/ai/provider

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "provider": "openai"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X PATCH 'https://panel.example.com:882/v1/accounts/demo/ai/provider' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"provider":"openai"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "provider": "openai"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Run a native SHM account AI provider request

Endpoint

POST /v1/accounts/{username}/ai/providers/{provider}/request

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (4)

Complete request template

This reference template contains all 4 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "provider": "demo",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "api_key": "YOUR_API_KEY",
    "payload": {}
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/ai/providers/demo/request' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"api_key":"YOUR_API_KEY","payload":{}}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "provider": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "api_key": "YOUR_API_KEY",
    "payload": {}
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Reset persisted SHM account AI provider state

Endpoint

POST /v1/accounts/{username}/ai/reset

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "conversation_id": 1,
    "provider": "openai"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/ai/reset' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"provider":"openai","conversation_id":1}'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "provider": "openai",
    "conversation_id": 1
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Run a guarded SHM account Malware Protection action. Automatic cleaning is disabled; quarantine, restore, and delete are explicit manual actions. `start_scan` accepts `scan_profile=daily|deep|paranoid` plus legacy `scan_mode=quick|deep`; daily uses managed YARA rules with ClamAV candidate confirmation, while deep/paranoid add complete ClamAV coverage and Maldet when enabled. Confirmation requires two independent signal lineages after duplicate upstream rule identities are collapsed. A path-based suppression requires an exact reviewed SHA-256 and fails open after any content change.

Operational guidance: Run one authorized account Malware Protection action. Paths are resolved inside the owned account roots. start_scan shares the isolated worker contract, but recovery metadata is restricted to root orchestration. scan_status may expose worker_launch_mode and recovery audit fields for an account-visible scan. A path-based suppression is audit-only and can apply only to an exact reviewed SHA-256; changed or injected content fails open to review/confirmation. Daily uses automatic YARA rules with ClamAV candidate confirmation; deep/paranoid add full ClamAV and Maldet coverage. Detection rows expose independent signal-lineage voting, and automatic cleaning remains disabled.

Endpoint

POST /v1/accounts/{username}/antivirus/actions/{action}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (14)

Supported actions and option sets

Complete request template

This reference template contains all 14 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "action": "start_scan",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "classification_filter": "actionable",
    "draw": 1,
    "file": "error.log",
    "files": [
      "public_html/cache/generated.php"
    ],
    "id": 1,
    "ids": "1,2",
    "length": 50,
    "scan_id": 1,
    "scan_mode": "deep",
    "scan_profile": "deep",
    "search": {
      "value": ""
    },
    "start": 0
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/antivirus/actions/start_scan' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"scan_profile":"deep","scan_mode":"deep"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "action": "start_scan"
  },
  "query_parameters": {},
  "json_body": {
    "scan_profile": "deep",
    "scan_mode": "deep"
  }
}

{
  "path_parameters": {
    "username": "demo",
    "action": "detections_dt"
  },
  "query_parameters": {},
  "json_body": {
    "scan_id": 1,
    "classification_filter": "actionable",
    "draw": 1,
    "start": 0,
    "length": 50,
    "search": {
      "value": ""
    }
  }
}

{
  "path_parameters": {
    "username": "demo",
    "action": "ignore_add"
  },
  "query_parameters": {},
  "json_body": {
    "files": [
      "public_html/cache/generated.php"
    ]
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Fetch the SHM account Malware Protection workspace. Reports separate confirmed, needs-review, and suppressed audit findings and expose the root-managed automatic rule profile, generation, and QA state.

Operational guidance: Read the account-scoped Malware Protection workspace. Authorization is enforced against the account owner/reseller. The response includes protection_enabled plus the automatic rule profile, generation, QA status, rules_health_status, and aggregate fallback/skipped source counts. Source selection and source-level technical details remain root-managed. Use reports_only for the progressive report selector and quarantine_only for a lightweight quarantine refresh.

Endpoint

GET /v1/accounts/{username}/antivirus/context

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (6)

Complete request template

This reference template contains all 6 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "include_active_scan": 1,
    "include_reports": 0,
    "quarantine_only": 1,
    "report_limit": 15,
    "reports_only": 1
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/antivirus/context?include_reports=0' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "include_reports": 0
  },
  "json_body": {}
}

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "reports_only": 1,
    "report_limit": 15
  },
  "json_body": {}
}

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "quarantine_only": 1
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Install a supported web application (one-click).

Operational guidance: Start a background app installation task. Target directory must be empty. Poll GET /v1/apps/install/{task} to read progress.

Endpoint

POST /v1/accounts/{username}/apps/install

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (13)

Supported actions and option sets

{
  "joomla": {
    "app": "joomla",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  },
  "drupal": {
    "app": "drupal",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  },
  "prestashop": {
    "app": "prestashop",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  },
  "opencart": {
    "app": "opencart",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  },
  "shopware": {
    "app": "shopware",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com",
    "admin_firstname": "Admin",
    "admin_lastname": "User"
  },
  "phpbb": {
    "app": "phpbb",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  },
  "mediawiki": {
    "app": "mediawiki",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  },
  "moodle": {
    "app": "moodle",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com",
    "site_shortname": "Moodle"
  },
  "nextcloud": {
    "app": "nextcloud",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com",
    "data_dir": "/home/demo/nextcloud-data"
  },
  "laravel": {
    "app": "laravel",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  },
  "symfony": {
    "app": "symfony",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  },
  "codeigniter": {
    "app": "codeigniter",
    "domain": "example.com",
    "folder": "",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

Complete request template

This reference template contains all 13 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "admin_email": "admin@example.com",
    "admin_pass": "S3cure!Pass#123",
    "admin_user": "admin",
    "app": "codeigniter",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_firstname": "Admin",
    "admin_lastname": "User",
    "backend_frontname": "admin",
    "data_dir": "/home/demo/nextcloud-data",
    "folder": "apps/wordpress",
    "site_shortname": "Moodle"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/apps/install' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"app":"codeigniter","domain":"example.com","site_title":"My Website","admin_user":"admin","admin_pass":"S3cure!Pass#123","admin_email":"admin@example.com"}'

Example note: Requires a documented runtime value before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "codeigniter",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "drupal",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "joomla",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "laravel",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "mediawiki",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "moodle",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com",
    "site_shortname": "Moodle"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "nextcloud",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com",
    "data_dir": "/home/demo/nextcloud-data"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "opencart",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "phpbb",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "prestashop",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "shopware",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com",
    "admin_firstname": "Admin",
    "admin_lastname": "User"
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "app": "symfony",
    "domain": "example.com",
    "site_title": "My Website",
    "admin_user": "admin",
    "admin_pass": "S3cure!Pass#123",
    "admin_email": "admin@example.com"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Read Apps Installer task status and progress.

Operational guidance: Read task status and progress log lines for a running/completed install.

Endpoint

GET /v1/accounts/{username}/apps/install/{task}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "task": "task-id-from-previous-response",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/apps/install/task-id-from-previous-response' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "task": "task-id-from-previous-response"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List installed applications tracked by Apps Manager.

Endpoint

GET /v1/accounts/{username}/apps/installed

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/apps/installed' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Remove an installed app and optionally related database/user.

Operational guidance: Remove an installed application record and delete its files. Path {id} is the install_id from the registry. Optionally remove its database and database user.

Endpoint

DELETE /v1/accounts/{username}/apps/installed/{id}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "id": 1,
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "remove_database": 0
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X DELETE 'https://panel.example.com:882/v1/accounts/demo/apps/installed/1' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"remove_database":0}'

Example note: Requires a documented runtime value before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "remove_database": 0
  }
}

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "remove_database": 1
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Create a short-lived one-time login ticket for a WHMCS service account. The request must be authenticated with an API key that is authorized for the target account, and SHM validates the real account username and password before issuing the ticket. The browser consumes the returned ticket only through /login.php; no root or reseller bypass is performed.

Endpoint

POST /v1/auth/whmcs-login-ticket

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI for an authorized root or reseller role. It is not part of the account-chat surface.

Parameters (6)

Complete request template

This reference template contains all 6 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "account_password": "STRONG_PASSWORD",
    "account_username": "demo",
    "client_ip": "203.0.113.10",
    "account_user": "demo",
    "redirect": "/",
    "user_agent": "Mozilla/5.0"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/auth/whmcs-login-ticket' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"account_username":"demo","account_user":"demo","account_password":"STRONG_PASSWORD","client_ip":"203.0.113.10","user_agent":"Mozilla/5.0","redirect":"/"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {},
  "query_parameters": {},
  "json_body": {
    "account_username": "demo",
    "account_user": "demo",
    "account_password": "STRONG_PASSWORD",
    "client_ip": "203.0.113.10",
    "user_agent": "Mozilla/5.0",
    "redirect": "/"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Read SHM account local backup context.

Endpoint

GET /v1/accounts/{username}/backup/local-context

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local-context' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Delete a SHM account local backup archive.

Endpoint

DELETE /v1/accounts/{username}/backup/local/backup

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "tag": "nightly"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X DELETE 'https://panel.example.com:882/v1/accounts/demo/backup/local/backup' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"tag":"nightly"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "tag": "nightly"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

List SHM account local backups.

Endpoint

GET /v1/accounts/{username}/backup/local/backups

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/backups' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Download a SHM account local backup archive.

Endpoint

GET /v1/accounts/{username}/backup/local/download

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "tag": "nightly"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/download?tag=nightly' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "tag": "nightly"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Read SHM account local backup file content

Endpoint

GET /v1/accounts/{username}/backup/local/files/content

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (4)

Complete request template

This reference template contains all 4 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "backup_point": "2026-07-16_02-00-00",
    "file": "error.log",
    "path": "/home/demo/public_html"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/files/content?path=%2Fhome%2Fdemo%2Fpublic_html&backup_point=2026-07-16_02-00-00&file=error.log' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "path": "/home/demo/public_html",
    "backup_point": "2026-07-16_02-00-00",
    "file": "error.log"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account local backup files and folders

Endpoint

GET /v1/accounts/{username}/backup/local/files/items

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "backup_point": "2026-07-16_02-00-00",
    "path": "/home/demo/public_html"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/files/items?path=%2Fhome%2Fdemo%2Fpublic_html&backup_point=2026-07-16_02-00-00' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "path": "/home/demo/public_html",
    "backup_point": "2026-07-16_02-00-00"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account local file backup points

Endpoint

GET /v1/accounts/{username}/backup/local/files/points

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/files/points' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Restore one file or folder from an account local backup point into a randomized isolated path below `/restore/ai-*`. The live path is never replaced by this endpoint. The worker uses the current authorized SHM account home, rejects source/destination symlinks, runs a safe account-owned copy, and records tenant-bound job ownership.

Operational guidance: Restore one file or folder from an authorized local backup point into a randomized isolated /restore/ai-* staging path. This endpoint never replaces the live item. After completion, inspect the staged result, preserve the live item separately, copy only the approved data with existing File Manager APIs, and verify the final path before claiming restoration.

Endpoint

POST /v1/accounts/{username}/backup/local/files/restore-staging

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "exampleacct"
  },
  "query_parameters": {},
  "json_body": {
    "backup_point": "2026-07-13_02-00-00",
    "path": "public_html/assets"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/exampleacct/backup/local/files/restore-staging' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"backup_point":"2026-07-13_02-00-00","path":"public_html/assets"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "exampleacct"
  },
  "query_parameters": {},
  "json_body": {
    "backup_point": "2026-07-13_02-00-00",
    "path": "public_html/assets"
  }
}

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "backup_point": "2026-07-13_02-00-00",
    "path": "public_html/assets"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Read the status of one tenant-bound account staging restore job. Foreign account jobs return not found.

Operational guidance: Read one tenant-bound staging restore status. Poll until completed or failed before inspecting or copying the staged data. A hash owned by another account is returned as not found.

Endpoint

GET /v1/accounts/{username}/backup/local/files/restore-staging/{restore_hash}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "restore_hash": "0123456789abcdef0123456789abcdef",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/files/restore-staging/0123456789abcdef0123456789abcdef' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "restore_hash": "0123456789abcdef0123456789abcdef"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Abort one running tenant-bound staging restore job. The PID must still identify the exact native worker and restore hash before its isolated process group is signalled.

Operational guidance: Abort one running tenant-bound staging restore after explicit confirmation. SHM signals a process group only when the PID still belongs to the exact native restore worker and exact restore hash; stale or foreign jobs are not signalled.

Endpoint

POST /v1/accounts/{username}/backup/local/files/restore-staging/{restore_hash}/abort

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "restore_hash": "0123456789abcdef0123456789abcdef",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/backup/local/files/restore-staging/0123456789abcdef0123456789abcdef/abort' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "restore_hash": "0123456789abcdef0123456789abcdef"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Read the bounded tenant-authorized log for one account staging restore job.

Operational guidance: Read the bounded log of one tenant-authorized staging restore. Use it to explain a failed or incomplete job without exposing another tenant.

Endpoint

GET /v1/accounts/{username}/backup/local/files/restore-staging/{restore_hash}/log

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "restore_hash": "0123456789abcdef0123456789abcdef",
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/files/restore-staging/0123456789abcdef0123456789abcdef/log' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "restore_hash": "0123456789abcdef0123456789abcdef"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Read SHM account local backup log content.

Endpoint

GET /v1/accounts/{username}/backup/local/log

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "tag": "nightly"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/log?tag=nightly' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "tag": "nightly"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Read SHM account local backup mail content

Endpoint

GET /v1/accounts/{username}/backup/local/mail/content

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (4)

Complete request template

This reference template contains all 4 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "backup_point": "2026-07-16_02-00-00",
    "file": "error.log",
    "mailPath": "/home/demo/public_html"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/mail/content?backup_point=2026-07-16_02-00-00&mailPath=%2Fhome%2Fdemo%2Fpublic_html&file=error.log' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "backup_point": "2026-07-16_02-00-00",
    "mailPath": "/home/demo/public_html",
    "file": "error.log"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account local mail backup files and folders

Endpoint

GET /v1/accounts/{username}/backup/local/mail/items

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "backup_point": "2026-07-16_02-00-00",
    "mailPath": "/home/demo/public_html"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/mail/items?backup_point=2026-07-16_02-00-00&mailPath=%2Fhome%2Fdemo%2Fpublic_html' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "backup_point": "2026-07-16_02-00-00",
    "mailPath": "/home/demo/public_html"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account local mail backup points

Endpoint

GET /v1/accounts/{username}/backup/local/mail/points

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/mail/points' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account local MySQL backup databases or tables

Endpoint

GET /v1/accounts/{username}/backup/local/mysql/items

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "backup_point": "2026-07-16_02-00-00",
    "dbName": "appdb"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/mysql/items?backup_point=2026-07-16_02-00-00&dbName=appdb' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "backup_point": "2026-07-16_02-00-00",
    "dbName": "appdb"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account local MySQL backup points

Endpoint

GET /v1/accounts/{username}/backup/local/mysql/points

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/mysql/points' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Start a SHM account local backup.

Endpoint

POST /v1/accounts/{username}/backup/local/start

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "tag": "nightly"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/backup/local/start' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"tag":"nightly"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "tag": "nightly"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Read SHM account local backup status.

Endpoint

GET /v1/accounts/{username}/backup/local/status

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "tag": "nightly"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/local/status?tag=nightly' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "tag": "nightly"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Read SHM account remote backup context.

Endpoint

GET /v1/accounts/{username}/backup/remote-context

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/remote-context' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Abort SHM account remote file restore

Endpoint

POST /v1/accounts/{username}/backup/remote/files/abort

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "session": "SESSION_ID_FROM_START_RESPONSE"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/backup/remote/files/abort' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"session":"SESSION_ID_FROM_START_RESPONSE"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "session": "SESSION_ID_FROM_START_RESPONSE"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Read SHM account remote backup file content.

Endpoint

GET /v1/accounts/{username}/backup/remote/files/content

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (4)

Complete request template

This reference template contains all 4 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "date": "2026-07-16",
    "file": "error.log",
    "path": "/home/demo/public_html"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/remote/files/content?date=2026-07-16&file=error.log' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "date": "2026-07-16",
    "file": "error.log"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account remote backup files and folders.

Endpoint

GET /v1/accounts/{username}/backup/remote/files/items

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "date": "2026-07-16",
    "path": "/home/demo/public_html"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/remote/files/items?date=2026-07-16' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "date": "2026-07-16"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account remote file backup points.

Endpoint

GET /v1/accounts/{username}/backup/remote/files/points

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/remote/files/points' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Start SHM account remote file restore

Endpoint

POST /v1/accounts/{username}/backup/remote/files/restore

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (4)

Complete request template

This reference template contains all 4 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "date": "2026-07-16",
    "location": "remote-main",
    "path": "/home/demo/public_html"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/backup/remote/files/restore' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"path":"/home/demo/public_html","date":"2026-07-16","location":"remote-main"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "path": "/home/demo/public_html",
    "date": "2026-07-16",
    "location": "remote-main"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Abort SHM account remote MySQL restore

Endpoint

POST /v1/accounts/{username}/backup/remote/mysql/abort

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "session": "SESSION_ID_FROM_START_RESPONSE"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/backup/remote/mysql/abort' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"session":"SESSION_ID_FROM_START_RESPONSE"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "session": "SESSION_ID_FROM_START_RESPONSE"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

List SHM account remote MySQL backup databases or tables.

Endpoint

GET /v1/accounts/{username}/backup/remote/mysql/items

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "date": "2026-07-16",
    "dbName": "appdb"
  },
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/remote/mysql/items?date=2026-07-16' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {
    "date": "2026-07-16"
  },
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

List SHM account remote MySQL backup points.

Endpoint

GET /v1/accounts/{username}/backup/remote/mysql/points

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/backup/remote/mysql/points' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Start SHM account remote MySQL restore

Endpoint

POST /v1/accounts/{username}/backup/remote/mysql/restore

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (4)

Complete request template

This reference template contains all 4 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "database": "appdb",
    "date": "2026-07-16",
    "location": "remote-main"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/backup/remote/mysql/restore' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"date":"2026-07-16","location":"remote-main","database":"appdb"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "date": "2026-07-16",
    "location": "remote-main",
    "database": "appdb"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Clear the saved Cloudflare API token for the account.

Endpoint

DELETE /v1/accounts/{username}/cloudflare/connect

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X DELETE 'https://panel.example.com:882/v1/accounts/demo/cloudflare/connect' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Save a Cloudflare API token for the account and optionally enable automatic subdomain sync.

Endpoint

POST /v1/accounts/{username}/cloudflare/connect

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "api_token": "ONE_TIME_TOKEN",
    "auto_sync_subdomains": 1
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/cloudflare/connect' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"api_token":"ONE_TIME_TOKEN"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "api_token": "ONE_TIME_TOKEN"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Fetch SHM account Cloudflare workspace context.

Endpoint

GET /v1/accounts/{username}/cloudflare/context

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (1)

Complete request template

This reference template contains all 1 current parameter key. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/cloudflare/context' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Sync the local DNS zone for a selected domain to Cloudflare without removing unrelated Cloudflare records.

Endpoint

POST /v1/accounts/{username}/cloudflare/domains/sync

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "domain": "example.com"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/cloudflare/domains/sync' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"domain":"example.com"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "domain": "example.com"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Update SHM account Cloudflare settings.

Endpoint

PATCH /v1/accounts/{username}/cloudflare/settings

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "auto_sync_subdomains": 1
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X PATCH 'https://panel.example.com:882/v1/accounts/demo/cloudflare/settings' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"auto_sync_subdomains":1}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "auto_sync_subdomains": 1
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Sync one account subdomain DNS record to Cloudflare.

Endpoint

POST /v1/accounts/{username}/cloudflare/subdomains/sync

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "domain": "example.com",
    "ip": "203.0.113.10"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/cloudflare/subdomains/sync' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"domain":"example.com"}'

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo"
  },
  "query_parameters": {},
  "json_body": {
    "domain": "example.com"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

List Cloudflare DNS records for a matched zone connected to the account.

Operational guidance: List Cloudflare DNS records using the account personal API token.

Endpoint

GET /v1/accounts/{username}/cloudflare/zones/{zone_id}/records

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/cloudflare/zones/1/records' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Create a Cloudflare DNS record in a matched zone.

Operational guidance: Create a Cloudflare DNS record using the account personal API token.

Endpoint

POST /v1/accounts/{username}/cloudflare/zones/{zone_id}/records

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (9)

Complete request template

This reference template contains all 9 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {
    "content": "Example content",
    "name": "Primary",
    "type": "A",
    "comment": "Managed by automation",
    "priority": "priority",
    "proxied": 1,
    "ttl": 3600
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/cloudflare/zones/1/records' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"type":"A","name":"Primary","content":"Example content"}'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {
    "type": "A",
    "name": "Primary",
    "content": "Example content"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Delete a Cloudflare DNS record from a matched zone.

Operational guidance: Delete a Cloudflare DNS record using the account personal API token.

Endpoint

DELETE /v1/accounts/{username}/cloudflare/zones/{zone_id}/records/{record_id}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (3)

Complete request template

This reference template contains all 3 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "record_id": 1,
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X DELETE 'https://panel.example.com:882/v1/accounts/demo/cloudflare/zones/1/records/1' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1,
    "record_id": 1
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Update a Cloudflare DNS record in a matched zone.

Operational guidance: Update a Cloudflare DNS record using the account personal API token.

Endpoint

PATCH /v1/accounts/{username}/cloudflare/zones/{zone_id}/records/{record_id}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (10)

Complete request template

This reference template contains all 10 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "record_id": 1,
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {
    "comment": "Managed by automation",
    "content": "Example content",
    "name": "Primary",
    "priority": 1,
    "proxied": 1,
    "ttl": 3600,
    "type": "A"
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X PATCH 'https://panel.example.com:882/v1/accounts/demo/cloudflare/zones/1/records/1' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"type":"A","name":"Primary","content":"Example content","ttl":3600}'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1,
    "record_id": 1
  },
  "query_parameters": {},
  "json_body": {
    "type": "A",
    "name": "Primary",
    "content": "Example content",
    "ttl": 3600
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

Purge SHM account Cloudflare zone cache

Operational guidance: Empty body defaults to purge_everything=true.

Endpoint

POST /v1/accounts/{username}/cloudflare/zones/{zone_id}/cache/purge

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (7)

Complete request template

This reference template contains all 7 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {
    "files": [],
    "hosts": "host.example.com",
    "prefixes": [],
    "purge_everything": 1,
    "tags": []
  },
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X POST 'https://panel.example.com:882/v1/accounts/demo/cloudflare/zones/1/cache/purge' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"purge_everything":1,"files":[],"tags":[],"hosts":"host.example.com"}'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {
    "purge_everything": 1,
    "files": [],
    "tags": [],
    "hosts": "host.example.com"
  }
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint can change state. Confirm the target and current state, keep a recovery path, and do not retry it blindly after an unknown result.

What this endpoint does

List SHM account Cloudflare zone settings

Operational guidance: Read Cloudflare zone settings using the account personal API token.

Endpoint

GET /v1/accounts/{username}/cloudflare/zones/{zone_id}/settings

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (2)

Complete request template

This reference template contains all 2 current parameter keys. Keys under query_or_json_parameters may be sent in either accepted location. Conditional or action-specific keys are alternatives; keep only the branch you are actually calling.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {},
  "query_or_json_parameters": {}
}

Runnable workflow example

curl -sS -X GET 'https://panel.example.com:882/v1/accounts/demo/cloudflare/zones/1/settings' \
  -H 'X-Api-User: demo' \
  -H 'X-Api-Key: YOUR_API_KEY'

Example note: Requires a value returned by another endpoint before QA can execute this request.

Documented workflow examples

These are valid workflow branches from the current contract. They may use only the keys needed for that branch; the complete template above remains the exhaustive key list.

{
  "path_parameters": {
    "username": "demo",
    "zone_id": 1
  },
  "query_parameters": {},
  "json_body": {}
}

Successful result

On success, SHM returns a JSON success envelope and the endpoint-specific state or result described below. Verify a mutation with the corresponding read endpoint or owning SHM page.

The success payload is endpoint-specific. Read the returned status, preserve request_id when present, and inspect the resource fields described by the endpoint.

Error response

{
  "status": "error",
  "code": "validation_error",
  "message": "One or more required parameters are missing or invalid."
}

Operational note

This endpoint reads state. Use its current identifiers and result before calling a related create, update, delete, repair, or restore operation.

What this endpoint does

Update SHM account Cloudflare zone setting

Operational guidance: Supported settings: development_mode, security_level, cache_level, always_online, brotli.

Endpoint

PATCH /v1/accounts/{username}/cloudflare/zones/{zone_id}/settings/{setting}

Authentication and permissions

Send X-Api-User and X-Api-Key. Root, the owning reseller, and the account user may call this endpoint inside their authorized account scope.

AI Mode availability

Discoverable by Workspace AI and Account AI when the authenticated role, account ownership, feature policy, and parameters permit it.

Parameters (4)