---
title: "Start cloud test"
method: POST
path: "/diagnostic/cloudconnection"
tags: ["Diagnostic"]
---

# Start cloud test

`POST /diagnostic/cloudconnection`

## Request

- Base URL: `https://localhost:8446/api/v2`
- URL: `https://localhost:8446/api/v2/diagnostic/cloudconnection`
- Auth: API key in header `Authorization`

Start cloud connection test.

## Request body

- object
  - `agent_id` number, required: Agent id
  - `storage_id` number: Storage id
  - `storage_name` string: Storage name
  - `config` object: Config for storage. Available fields: s3 - type, auth_type, access_id, access_secret, bucket, region s3c - type, auth_type, access_id, access_secret, bucket, region, endpoint, use_ssl azure, af - type, account, auth_type, key, sas_token, container, endpoint gs - type, auth_type, access_id, access_secret, bucket, project sharepoint - type, auth_type, client_id, client_secret, tenant_id, root, drive
  - `config.type` string, required: Storage type
  - `config.auth_type` string: Authorization type. "sas" is applicable for azure and af storages. "iam" is applicable for s3 storages only. "secret" is applicable for "od" storages only
  - `config.access_id` string: Access ID for s3, s3c and gs storages if auth_type is "key"
  - `config.access_secret` string: Access secret for s3, s3c and gs storages if auth_type is "key"
  - `config.bucket` string: Bucket for s3, s3c and gs storages
  - `config.region` string: Region for s3 and s3c storages
  - `config.endpoint` string: Endpoint for s3c, azure and af storages
  - `config.account` string: Account for azure and af storage
  - `config.key` string: Key for azure and af storage if auth_type is "key"
  - `config.sas_token` string: SAS token for azure and af storage if auth_type is "sas"
  - `config.container` string: Container for azure and af storage
  - `config.project` string: Project for gs storage
  - `config.use_ssl` boolean: Should use SSL for s3c storage
  - `config.client_id` string: Application ID for SharePoint
  - `config.client_secret` string: Application secret for SharePoint
  - `config.tenant_id` string: Tenant ID for SharePoint
  - `config.root` string: Root for SharePoint
  - `config.drive` string: Drive for SharePoint Please set the maximum request timeout (more than 30 sec) because the test may take a long time.

## Response `200`

Successful response

- object
  - `messages` object, required: Array of test results strings
  - `is_error` boolean: Flag which indicated that test failed

## Other responses

- `default`: Error response. Depending on the error, either a 4xx or 5xx response status is returned.

---

[API](https://skmtc.dev/resilio/apis/resilio-api.md) - [All operations](https://skmtc.dev/resilio/apis/resilio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/resilio/apis/resilio-api/revisions/ca39130a395e?raw)
