Diagnostic

Start cloud test

Start cloud connection test.

post/diagnostic/cloudconnection

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Request body

agent_idnumber required

Agent id

storage_idnumber

Storage id

storage_namestring

Storage name

configobject

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.typestring required

Storage type

config.auth_typestring

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_idstring

Access ID for s3, s3c and gs storages if auth_type is "key"

config.access_secretstring

Access secret for s3, s3c and gs storages if auth_type is "key"

config.bucketstring

Bucket for s3, s3c and gs storages

config.regionstring

Region for s3 and s3c storages

config.endpointstring

Endpoint for s3c, azure and af storages

config.accountstring

Account for azure and af storage

config.keystring

Key for azure and af storage if auth_type is "key"

config.sas_tokenstring

SAS token for azure and af storage if auth_type is "sas"

config.containerstring

Container for azure and af storage

config.projectstring

Project for gs storage

config.use_sslboolean

Should use SSL for s3c storage

config.client_idstring

Application ID for SharePoint

config.client_secretstring

Application secret for SharePoint

config.tenant_idstring

Tenant ID for SharePoint

config.rootstring

Root for SharePoint

config.drivestring

Drive for SharePoint

Please set the maximum request timeout (more than 30 sec) because the test may take a long time.

Response

Successful response

messagesobject required

Array of test results strings

is_errorboolean

Flag which indicated that test failed

Changes

No recorded changes to this operation across all 1 revision of this API.