Skip to content

Undeploy account

About

Stops API server and trading terminal for trading account. This request will be ignored if trading account is already undeployed

POST /users/current/accounts/:accountId/undeploy

For more information see swagger documentation

Headers

Name Type Required Description
auth-token string Yes Authorization token. See Authentication and authorization

Path parameters

Name Type Required Description
accountId string Yes Trading account id

Query parameters

Name Type Required Description
executeForAllReplicas boolean If true, current operation will be executed for all replicas. Default is true

Response

  • 204 - Trading account was successfully undeployed
  • 401 - Authorization failed. Response schema: Error
  • 403 - Method or resource access permissions are missing. Response schema: Error
  • 404 - Trading account with specified id not found. Response schema: Error

Examples

Example request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'auth-token: token' 'https://mt-provisioning-api-v1.agiliumtrade.agiliumtrade.ai/users/current/accounts/1eda642a-a9a3-457c-99af-3bc5e8d5c4c9/undeploy'