NAnace
Workspaces

Save a connection's setup options

Save the non-secret inputs the setup is generated from, such as the AWS account and role name, or the Azure subscription and resource group, and get the setup back. Its type must match the destination's. Free. Only where customer storage is on for the deployment; where it is off, every storage connection route answers 404 storage_connection_unavailable once the API key is accepted, before checking the request or its body.

put/v1/storage-connections/{id}/setup

Request

Path parameters

idstring uuid required

The connection's id.

Request body

OR

Response

The setup, generated from the saved options.

trust_policystring nullable

S3: the IAM role trust policy, as JSON.

permissions_policystring nullable

S3: the IAM permissions policy for the bucket and any KMS key, as JSON.

cloudformation_templatestring nullable

S3: a CloudFormation template that creates the role, as JSON.

launch_urlstring nullable

S3: an AWS console link that opens that stack, once the account id and role name are saved.

role_arnstring nullable

S3: the ARN the stack's role will have.

azure_clistring nullable

Azure: the az commands that give the service principal access to the container.

Changes

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