StudioHomepage
ServicesConnectionsHTTP APIUnknown

Create_connection

POST
/api/connections

Create a Connection scoped to one Project.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Request Body

application/json
  1. body
credential*||||||||||

A complete replacement credential, including every required secret. OIDC credentials contain no stored secret.

description?string|null
projectId*string
uri*string

Response Body

Success

application/json
  1. response
connection*
versionId*string
Formatuuid
curl -X POST 'https://api.spiraldb.dev/api/connections' \  -H 'Content-Type: application/json' \  -d '{  "credential": {    "awsAccessKey": {      "accessKeyId": "string",      "secretAccessKey": "string"    },    "type": "awsAccessKey"  },  "projectId": "string",  "uri": "string"}'
{  "connection": {    "allowedAccess": "read",    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",    "createdAtMicros": "string",    "createdBy": "string",    "credential": {      "awsAccessKey": {        "accessKeyId": "string",        "region": "string"      },      "type": "awsAccessKey"    },    "credentialUpdatedAtMicros": "string",    "description": "string",    "dropped": {      "droppedAtMicros": "string",      "droppedBy": "string"    },    "identity": {      "audience": "string",      "issuer": "string",      "subject": "string",      "trustPolicy": "string"    },    "projectId": "string",    "uri": "string"  },  "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7"}