NaceDocs
DashboardGet an API key
DocumentationAPI ReferenceSDKsCLI

Workspaces

Save a connection's credentials

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

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

AWS role credential
Show child attributes
Azure service principal credential
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/credentials" \  -H "Content-Type: application/json" \  -d '{    "type": "aws_role",    "role_arn": "arn:aws:iam::444455556666:role/nace-workspaces"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "destination": {    "type": "s3",    "bucket": "string",    "region": "string",    "prefix": ""  },  "status": "draft",  "can_manage": true,  "external_id": "string",  "aws_trusted_principal_arn": "string",  "aws_trusted_principal_arns": [    "string"  ],  "credentials_pending": true,  "validation_running": true,  "credential_generation": 0,  "validated_at": "2019-08-24T14:15:22Z",  "reactivation_requires_approval": true,  "revoked_reason": "owner",  "revoked_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}

Save a connection's setup options PUT

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.

Validate a storage connection POST

Start a storage_validation job that checks Nace can write, read and delete in the destination, from both its API and its workers.