Register a storage connection

POST

api

storage-connections

curl --request POST \
  --url https://api.nitsor.com/api/v1/storage-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bucket": "<string>",
  "credentialHandle": "<string>",
  "idempotencyKey": "<string>",
  "name": "<string>",
  "pathStyle": true,
  "prefix": "<string>",
  "region": "<string>",
  "endpoint": "<string>",
  "provider": {
    "kind": "amazon-s3"
  }
}
'

import requests

url = "https://api.nitsor.com/api/v1/storage-connections"

payload = {
    "bucket": "<string>",
    "credentialHandle": "<string>",
    "idempotencyKey": "<string>",
    "name": "<string>",
    "pathStyle": True,
    "prefix": "<string>",
    "region": "<string>",
    "endpoint": "<string>",
    "provider": { "kind": "amazon-s3" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bucket: '<string>',
    credentialHandle: '<string>',
    idempotencyKey: '<string>',
    name: '<string>',
    pathStyle: true,
    prefix: '<string>',
    region: '<string>',
    endpoint: '<string>',
    provider: {kind: 'amazon-s3'}
  })
};

fetch('https://api.nitsor.com/api/v1/storage-connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nitsor.com/api/v1/storage-connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bucket' => '<string>',
    'credentialHandle' => '<string>',
    'idempotencyKey' => '<string>',
    'name' => '<string>',
    'pathStyle' => true,
    'prefix' => '<string>',
    'region' => '<string>',
    'endpoint' => '<string>',
    'provider' => [
        'kind' => 'amazon-s3'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nitsor.com/api/v1/storage-connections"

	payload := strings.NewReader("{\n  \"bucket\": \"<string>\",\n  \"credentialHandle\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pathStyle\": true,\n  \"prefix\": \"<string>\",\n  \"region\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"provider\": {\n    \"kind\": \"amazon-s3\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nitsor.com/api/v1/storage-connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bucket\": \"<string>\",\n  \"credentialHandle\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pathStyle\": true,\n  \"prefix\": \"<string>\",\n  \"region\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"provider\": {\n    \"kind\": \"amazon-s3\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/storage-connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bucket\": \"<string>\",\n  \"credentialHandle\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pathStyle\": true,\n  \"prefix\": \"<string>\",\n  \"region\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"provider\": {\n    \"kind\": \"amazon-s3\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "accountId": "<string>",
  "bucket": "<string>",
  "connectionId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "credential": {
    "handleId": "<string>",
    "kind": "handle",
    "label": "<string>"
  },
  "endpoint": "<string>",
  "name": "<string>",
  "pathStyle": true,
  "prefix": "<string>",
  "region": "<string>",
  "provider": {
    "kind": "amazon-s3"
  }
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Authorizations

Authorization

string

header

required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Body

application/json

bucket

string

required

Required string length: 1 - 63

credentialHandle

string

required

Pattern: ^sch_[a-z0-9][a-z0-9_-]{0,59}$

idempotencyKey

string

required

Required string length: 1 - 200

name

string

required

Required string length: 1 - 200

pathStyle

boolean

required

prefix

string

required

Maximum string length: 1024

region

string

required

Required string length: 1 - 64

endpoint

string

Omit for Amazon S3, Cloudflare R2 or Google Cloud Storage HMAC to use the selected provider's fixed template. A supplied endpoint must match that template exactly. Required for custom and S3-compatible connections and requests without a provider. Approved custom hosts, including arbitrary endpoints paired with sealed customer credential handles, require the exact endpoint hostname to be approved for the requesting account and pathStyle: true. Custom approval, creation, credential-handle rebinding and worker credential binding remain disabled until worker connect-time address checks ship. NITSOR_STORAGE_CUSTOM_HOSTS must remain unset or off; any other value, including resolver-verified, is refused. After that guard is removed, admission requires approval and pathStyle: true. Legacy requests using operator-provisioned handles retain S3-compatible behavior. An absolute https URL with no embedded username or password; the credentials come from the provisioned credential handle credentialHandle names (an id starting sch_). localhost, names ending .localhost, private, loopback or link-local IP address literals, and IPv6 literals that carry an IPv4 address (mapped, NAT64, 6to4) are refused on the literal hostname given; connection and signing-time requests validate that literal and its policy, not the address a later DNS resolution or worker connects to, and follow no redirect. Custom worker traffic remains disabled pending its own connect-time address checks. A deployment accepts http only when its operator sets NITSOR_STORAGE_HTTP_ENDPOINTS=local-development.

Maximum string length: 2048

provider

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

Response

accountId

string

required

Minimum string length: 1

bucket

string

required

Minimum string length: 1

connectionId

string

required

Minimum string length: 1

createdAt

string<date-time>

required

RFC 3339 timestamp in UTC: the offset is Z or +00:00; any other offset is refused.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$

credential

object

required

Option 1
Option 2

Show child attributes

endpoint

string

required

Minimum string length: 1

name

string

required

Minimum string length: 1

pathStyle

boolean

required

prefix

string

required

region

string

required

Minimum string length: 1

provider

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

curl --request POST \
  --url https://api.nitsor.com/api/v1/storage-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bucket": "<string>",
  "credentialHandle": "<string>",
  "idempotencyKey": "<string>",
  "name": "<string>",
  "pathStyle": true,
  "prefix": "<string>",
  "region": "<string>",
  "endpoint": "<string>",
  "provider": {
    "kind": "amazon-s3"
  }
}
'

import requests

url = "https://api.nitsor.com/api/v1/storage-connections"

payload = {
    "bucket": "<string>",
    "credentialHandle": "<string>",
    "idempotencyKey": "<string>",
    "name": "<string>",
    "pathStyle": True,
    "prefix": "<string>",
    "region": "<string>",
    "endpoint": "<string>",
    "provider": { "kind": "amazon-s3" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bucket: '<string>',
    credentialHandle: '<string>',
    idempotencyKey: '<string>',
    name: '<string>',
    pathStyle: true,
    prefix: '<string>',
    region: '<string>',
    endpoint: '<string>',
    provider: {kind: 'amazon-s3'}
  })
};

fetch('https://api.nitsor.com/api/v1/storage-connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nitsor.com/api/v1/storage-connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bucket' => '<string>',
    'credentialHandle' => '<string>',
    'idempotencyKey' => '<string>',
    'name' => '<string>',
    'pathStyle' => true,
    'prefix' => '<string>',
    'region' => '<string>',
    'endpoint' => '<string>',
    'provider' => [
        'kind' => 'amazon-s3'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nitsor.com/api/v1/storage-connections"

	payload := strings.NewReader("{\n  \"bucket\": \"<string>\",\n  \"credentialHandle\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pathStyle\": true,\n  \"prefix\": \"<string>\",\n  \"region\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"provider\": {\n    \"kind\": \"amazon-s3\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nitsor.com/api/v1/storage-connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bucket\": \"<string>\",\n  \"credentialHandle\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pathStyle\": true,\n  \"prefix\": \"<string>\",\n  \"region\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"provider\": {\n    \"kind\": \"amazon-s3\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/storage-connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bucket\": \"<string>\",\n  \"credentialHandle\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\",\n  \"pathStyle\": true,\n  \"prefix\": \"<string>\",\n  \"region\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"provider\": {\n    \"kind\": \"amazon-s3\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "accountId": "<string>",
  "bucket": "<string>",
  "connectionId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "credential": {
    "handleId": "<string>",
    "kind": "handle",
    "label": "<string>"
  },
  "endpoint": "<string>",
  "name": "<string>",
  "pathStyle": true,
  "prefix": "<string>",
  "region": "<string>",
  "provider": {
    "kind": "amazon-s3"
  }
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Reference

API operations

Register a storage connection

Authorizations

Body

Response