NaceDocs
DashboardGet an API key
DocumentationAPI ReferenceSDKsCLI

Workspaces

Save a connection's setup options

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

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer nace_sk_...

  • Where: the dashboard's API Keys page. It is shown once, when you create it.
  • Format: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -).
  • Limit: an account can hold at most 3 active keys.
  • Wrong or missing key: returns 401 authentication_error.

In: header

Path Parameters

idstringrequired

The connection's id.

Formatuuid

Request Body

application/json

S3 setup options
Show child attributes
Azure setup options
Show child attributes

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/storage-connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/setup" \  -H "Content-Type: application/json" \  -d '{    "type": "s3",    "aws_account_id": "444455556666",    "role_name": "nace-workspaces"  }'
{  "options": {    "type": "s3",    "access_method": "auto",    "aws_account_id": "444455556666",    "role_name": "nace-workspaces",    "kms_key_arn": null  },  "trust_policy": "{\"Version\": \"2012-10-17\", ...}",  "permissions_policy": "{\"Version\": \"2012-10-17\", ...}",  "cloudformation_template": "{\"AWSTemplateFormatVersion\": \"2010-09-09\", ...}",  "launch_url": "https://console.aws.amazon.com/cloudformation/home#/stacks/quickcreate?...",  "role_arn": "arn:aws:iam::444455556666:role/nace-workspaces",  "azure_cli": null}

Read a connection's setup GET

What to create in your cloud so Nace can reach the destination: for S3, an IAM role trust policy carrying the connection's external_id, its permissions policy, a CloudFormation template and quick-create link; for Azure, the CLI commands that give a service principal access to the container.

Save a connection's credentials PUT

The IAM role ARN, or the Azure service principal and its secret, Nace uses to reach the destination.