Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_ExcerptBetaAPI
_ExcerptBetaAPI
nopaneltrue

...

Authorization scopes supported:

ScopeAccess granted
interaction-content:readEntire endpoint

Parameters

The endpoint accepts the following body parameters:

storageProvider

Type

Required

Example

StringTrueS3

Storage provider. Currently supported storage providers: 

  • S3

credentials

Type

Required

Example

ObjectTrue

{

  "roleArn": "arn:aws:iam::account:role/role-name-with-path",

  "region": "us-east-1",

  "bucketName": "customer-bucket"

}

Credentials to the external storage that allow VCC to transfer data to it. The format of the object depends on the selected provider. For more information see the following table:

ProviderFormat
S3
{
  "roleArn": "string",
  "region": "string",
  "bucketName": "string"
}

...

Code Block
languagejs
themeMidnight
{
  "jobIdexternalStorageId": "74137e23-9716-4e5c-ad92-36343c248282"
}

where:

  • jobIdexternalStorageId. The unique identifier of the external storage item.

...