Skip to main content
POST
/
api
/
cloud-integrations
/
s3
Create S3 integration
curl --request POST \
  --url https://api-prod.nomadicml.com/api/cloud-integrations/s3 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "access_key_id": "<string>",
  "secret_access_key": "<string>",
  "bucket": "<string>",
  "type": "s3",
  "session_token": "<string>",
  "region": "<string>",
  "endpoint_url": "<string>",
  "prefix": "<string>"
}
'
import requests

url = "https://api-prod.nomadicml.com/api/cloud-integrations/s3"

payload = {
"name": "<string>",
"access_key_id": "<string>",
"secret_access_key": "<string>",
"bucket": "<string>",
"type": "s3",
"session_token": "<string>",
"region": "<string>",
"endpoint_url": "<string>",
"prefix": "<string>"
}
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({
name: '<string>',
access_key_id: '<string>',
secret_access_key: '<string>',
bucket: '<string>',
type: 's3',
session_token: '<string>',
region: '<string>',
endpoint_url: '<string>',
prefix: '<string>'
})
};

fetch('https://api-prod.nomadicml.com/api/cloud-integrations/s3', 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-prod.nomadicml.com/api/cloud-integrations/s3",
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([
'name' => '<string>',
'access_key_id' => '<string>',
'secret_access_key' => '<string>',
'bucket' => '<string>',
'type' => 's3',
'session_token' => '<string>',
'region' => '<string>',
'endpoint_url' => '<string>',
'prefix' => '<string>'
]),
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-prod.nomadicml.com/api/cloud-integrations/s3"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"access_key_id\": \"<string>\",\n \"secret_access_key\": \"<string>\",\n \"bucket\": \"<string>\",\n \"type\": \"s3\",\n \"session_token\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"prefix\": \"<string>\"\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-prod.nomadicml.com/api/cloud-integrations/s3")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"access_key_id\": \"<string>\",\n \"secret_access_key\": \"<string>\",\n \"bucket\": \"<string>\",\n \"type\": \"s3\",\n \"session_token\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"prefix\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-prod.nomadicml.com/api/cloud-integrations/s3")

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 \"name\": \"<string>\",\n \"access_key_id\": \"<string>\",\n \"secret_access_key\": \"<string>\",\n \"bucket\": \"<string>\",\n \"type\": \"s3\",\n \"session_token\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint_url\": \"<string>\",\n \"prefix\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "bucket": "<string>",
  "prefix": "<string>",
  "region": "<string>",
  "endpoint_url": "<string>",
  "role_arn": "<string>",
  "created_at": "<string>",
  "last_used": "<string>",
  "is_owner": true
}
{
"detail": "<string>",
"message": "<string>",
"error": "<string>"
}
{
"detail": "<string>",
"message": "<string>",
"error": "<string>"
}
{
"detail": "<string>",
"message": "<string>",
"error": "<string>"
}
{
"detail": "<string>",
"message": "<string>",
"error": "<string>"
}
{
"detail": "<string>",
"message": "<string>",
"error": "<string>"
}
{
"detail": "<string>",
"message": "<string>",
"error": "<string>"
}

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <NOMADIC_API_KEY>.

Body

application/json
name
string
required
access_key_id
string
required
secret_access_key
string<password>
required
write-only
bucket
string
required
type
string
default:s3
session_token
string<password>
write-only
region
string
endpoint_url
string
prefix
string

Response

Successful response.

id
string
name
string
type
enum<string>
Available options:
gcs,
s3,
hf_bucket,
s3_storage_transfer
bucket
string
prefix
string
region
string
endpoint_url
string
role_arn
string
created_at
string
last_used
string
is_owner
boolean