Create a resource
curl --request POST \
--url https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Id: <tenant-id>' \
--data '
{
"name": "<string>",
"description": "<string>",
"environment_id": "<string>",
"bucket_name": "<string>",
"allowed_headers": [
"<string>"
],
"allowed_methods": [],
"allowed_origins": [
"<string>"
],
"default_root_object": "<string>",
"auto_delete_objects": true,
"versioned": true,
"enforce_ssl": true,
"allow_cdn_access": true
}
'import requests
url = "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource"
payload = {
"name": "<string>",
"description": "<string>",
"environment_id": "<string>",
"bucket_name": "<string>",
"allowed_headers": ["<string>"],
"allowed_methods": [],
"allowed_origins": ["<string>"],
"default_root_object": "<string>",
"auto_delete_objects": True,
"versioned": True,
"enforce_ssl": True,
"allow_cdn_access": True
}
headers = {
"Tenant-Id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Tenant-Id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
environment_id: '<string>',
bucket_name: '<string>',
allowed_headers: ['<string>'],
allowed_methods: [],
allowed_origins: ['<string>'],
default_root_object: '<string>',
auto_delete_objects: true,
versioned: true,
enforce_ssl: true,
allow_cdn_access: true
})
};
fetch('https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource', 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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource",
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>',
'description' => '<string>',
'environment_id' => '<string>',
'bucket_name' => '<string>',
'allowed_headers' => [
'<string>'
],
'allowed_methods' => [
],
'allowed_origins' => [
'<string>'
],
'default_root_object' => '<string>',
'auto_delete_objects' => true,
'versioned' => true,
'enforce_ssl' => true,
'allow_cdn_access' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Tenant-Id: <tenant-id>"
],
]);
$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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"bucket_name\": \"<string>\",\n \"allowed_headers\": [\n \"<string>\"\n ],\n \"allowed_methods\": [],\n \"allowed_origins\": [\n \"<string>\"\n ],\n \"default_root_object\": \"<string>\",\n \"auto_delete_objects\": true,\n \"versioned\": true,\n \"enforce_ssl\": true,\n \"allow_cdn_access\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Tenant-Id", "<tenant-id>")
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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource")
.header("Tenant-Id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"bucket_name\": \"<string>\",\n \"allowed_headers\": [\n \"<string>\"\n ],\n \"allowed_methods\": [],\n \"allowed_origins\": [\n \"<string>\"\n ],\n \"default_root_object\": \"<string>\",\n \"auto_delete_objects\": true,\n \"versioned\": true,\n \"enforce_ssl\": true,\n \"allow_cdn_access\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Tenant-Id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"bucket_name\": \"<string>\",\n \"allowed_headers\": [\n \"<string>\"\n ],\n \"allowed_methods\": [],\n \"allowed_origins\": [\n \"<string>\"\n ],\n \"default_root_object\": \"<string>\",\n \"auto_delete_objects\": true,\n \"versioned\": true,\n \"enforce_ssl\": true,\n \"allow_cdn_access\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"resource_type": "s3",
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "DEFINED",
"bucket_name": "<string>",
"removal_policy": "DESTROY",
"auto_delete_objects": true,
"versioned": true,
"encryption": "UNENCRYPTED",
"block_public_access": "BLOCK_ALL",
"enforce_ssl": true,
"allowed_headers": [
"<string>"
],
"allowed_methods": [
"GET"
],
"allowed_origins": [
"<string>"
],
"default_root_object": "<string>",
"deletable": true,
"allow_cdn_access": true,
"stack_info": {
"bucket_name": "<string>",
"bucket_arn": "<string>",
"bucket_domain_name": "<string>",
"bucket_regional_domain": "<string>",
"bucket_website_url": "<string>",
"bucket_website_domain_name": "<string>",
"bucket_dual_stack_domain_name": "<string>",
"distribution_arn": "<string>",
"distribution_domain_name": "<string>",
"distribution_id": "<string>"
},
"month_cost": null
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}Resources
Create a resource
POST
/
resource
Create a resource
curl --request POST \
--url https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Id: <tenant-id>' \
--data '
{
"name": "<string>",
"description": "<string>",
"environment_id": "<string>",
"bucket_name": "<string>",
"allowed_headers": [
"<string>"
],
"allowed_methods": [],
"allowed_origins": [
"<string>"
],
"default_root_object": "<string>",
"auto_delete_objects": true,
"versioned": true,
"enforce_ssl": true,
"allow_cdn_access": true
}
'import requests
url = "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource"
payload = {
"name": "<string>",
"description": "<string>",
"environment_id": "<string>",
"bucket_name": "<string>",
"allowed_headers": ["<string>"],
"allowed_methods": [],
"allowed_origins": ["<string>"],
"default_root_object": "<string>",
"auto_delete_objects": True,
"versioned": True,
"enforce_ssl": True,
"allow_cdn_access": True
}
headers = {
"Tenant-Id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Tenant-Id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
environment_id: '<string>',
bucket_name: '<string>',
allowed_headers: ['<string>'],
allowed_methods: [],
allowed_origins: ['<string>'],
default_root_object: '<string>',
auto_delete_objects: true,
versioned: true,
enforce_ssl: true,
allow_cdn_access: true
})
};
fetch('https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource', 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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource",
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>',
'description' => '<string>',
'environment_id' => '<string>',
'bucket_name' => '<string>',
'allowed_headers' => [
'<string>'
],
'allowed_methods' => [
],
'allowed_origins' => [
'<string>'
],
'default_root_object' => '<string>',
'auto_delete_objects' => true,
'versioned' => true,
'enforce_ssl' => true,
'allow_cdn_access' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Tenant-Id: <tenant-id>"
],
]);
$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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"bucket_name\": \"<string>\",\n \"allowed_headers\": [\n \"<string>\"\n ],\n \"allowed_methods\": [],\n \"allowed_origins\": [\n \"<string>\"\n ],\n \"default_root_object\": \"<string>\",\n \"auto_delete_objects\": true,\n \"versioned\": true,\n \"enforce_ssl\": true,\n \"allow_cdn_access\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Tenant-Id", "<tenant-id>")
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://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource")
.header("Tenant-Id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"bucket_name\": \"<string>\",\n \"allowed_headers\": [\n \"<string>\"\n ],\n \"allowed_methods\": [],\n \"allowed_origins\": [\n \"<string>\"\n ],\n \"default_root_object\": \"<string>\",\n \"auto_delete_objects\": true,\n \"versioned\": true,\n \"enforce_ssl\": true,\n \"allow_cdn_access\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/resource")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Tenant-Id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"bucket_name\": \"<string>\",\n \"allowed_headers\": [\n \"<string>\"\n ],\n \"allowed_methods\": [],\n \"allowed_origins\": [\n \"<string>\"\n ],\n \"default_root_object\": \"<string>\",\n \"auto_delete_objects\": true,\n \"versioned\": true,\n \"enforce_ssl\": true,\n \"allow_cdn_access\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"resource_type": "s3",
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "DEFINED",
"bucket_name": "<string>",
"removal_policy": "DESTROY",
"auto_delete_objects": true,
"versioned": true,
"encryption": "UNENCRYPTED",
"block_public_access": "BLOCK_ALL",
"enforce_ssl": true,
"allowed_headers": [
"<string>"
],
"allowed_methods": [
"GET"
],
"allowed_origins": [
"<string>"
],
"default_root_object": "<string>",
"deletable": true,
"allow_cdn_access": true,
"stack_info": {
"bucket_name": "<string>",
"bucket_arn": "<string>",
"bucket_domain_name": "<string>",
"bucket_regional_domain": "<string>",
"bucket_website_url": "<string>",
"bucket_website_domain_name": "<string>",
"bucket_dual_stack_domain_name": "<string>",
"distribution_arn": "<string>",
"distribution_domain_name": "<string>",
"distribution_id": "<string>"
},
"month_cost": null
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}Authorizations
BearerAuthApiKeyAuth
Bearer token in the Authorization header (e.g. JWT / Cognito access token).
Headers
ID of the tenant (current tenant context).
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
One of the resource-specific create payloads (internal/app/resources).
models.ResourceType in paas-lib.
Available options:
s3, event_bus, lambda, api_gateway, cognito, cron, dynamodb, opensearch, pub_sub, parameter, secrets, postgres, role, ecs_image models.RemovalPolicy (paas-lib).
Available options:
DESTROY, RETAIN, SNAPSHOT, RETAIN_ON_UPDATE_OR_DELETE models.S3Encryption (paas-lib).
Available options:
UNENCRYPTED, S3_MANAGED, KMS_MANAGED, KMS, DSSE_MANAGED, DSSE models.S3BlockPublicAccess (paas-lib).
Available options:
BLOCK_ALL, BLOCK_ACLS models.S3AllowedMethods (paas-lib).
Available options:
GET, PUT, POST, DELETE, HEAD Response
Created
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
One of the resource-specific detail payloads (internal/app/resources).
models.ResourceType in paas-lib.
Available options:
s3, event_bus, lambda, api_gateway, cognito, cron, dynamodb, opensearch, pub_sub, parameter, secrets, postgres, role, ecs_image models.ResourceStatus (paas-lib).
Available options:
DEFINED, MODIFIED, DEPLOYED models.RemovalPolicy (paas-lib).
Available options:
DESTROY, RETAIN, SNAPSHOT, RETAIN_ON_UPDATE_OR_DELETE models.S3Encryption (paas-lib).
Available options:
UNENCRYPTED, S3_MANAGED, KMS_MANAGED, KMS, DSSE_MANAGED, DSSE models.S3BlockPublicAccess (paas-lib).
Available options:
BLOCK_ALL, BLOCK_ACLS models.S3AllowedMethods (paas-lib).
Available options:
GET, PUT, POST, DELETE, HEAD Show child attributes
Show child attributes