Creates a batch of resource plans
curl --request POST \
--url https://use.hoop.dev/api/resources/plan \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"privileges": [
"SELECT",
"INSERT"
],
"role": "ro",
"scopes": [
"mydb",
"otherdb.public"
],
"type": "managed",
"resource_name": "my-postgres",
"rotate_password": false,
"source_role": "pg_read_all_data"
}
]
}
'import requests
url = "https://use.hoop.dev/api/resources/plan"
payload = { "items": [
{
"privileges": ["SELECT", "INSERT"],
"role": "ro",
"scopes": ["mydb", "otherdb.public"],
"type": "managed",
"resource_name": "my-postgres",
"rotate_password": False,
"source_role": "pg_read_all_data"
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
privileges: ['SELECT', 'INSERT'],
role: 'ro',
scopes: ['mydb', 'otherdb.public'],
type: 'managed',
resource_name: 'my-postgres',
rotate_password: false,
source_role: 'pg_read_all_data'
}
]
})
};
fetch('https://use.hoop.dev/api/resources/plan', 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://use.hoop.dev/api/resources/plan",
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([
'items' => [
[
'privileges' => [
'SELECT',
'INSERT'
],
'role' => 'ro',
'scopes' => [
'mydb',
'otherdb.public'
],
'type' => 'managed',
'resource_name' => 'my-postgres',
'rotate_password' => false,
'source_role' => 'pg_read_all_data'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://use.hoop.dev/api/resources/plan"
payload := strings.NewReader("{\n \"items\": [\n {\n \"privileges\": [\n \"SELECT\",\n \"INSERT\"\n ],\n \"role\": \"ro\",\n \"scopes\": [\n \"mydb\",\n \"otherdb.public\"\n ],\n \"type\": \"managed\",\n \"resource_name\": \"my-postgres\",\n \"rotate_password\": false,\n \"source_role\": \"pg_read_all_data\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://use.hoop.dev/api/resources/plan")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"privileges\": [\n \"SELECT\",\n \"INSERT\"\n ],\n \"role\": \"ro\",\n \"scopes\": [\n \"mydb\",\n \"otherdb.public\"\n ],\n \"type\": \"managed\",\n \"resource_name\": \"my-postgres\",\n \"rotate_password\": false,\n \"source_role\": \"pg_read_all_data\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/resources/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"privileges\": [\n \"SELECT\",\n \"INSERT\"\n ],\n \"role\": \"ro\",\n \"scopes\": [\n \"mydb\",\n \"otherdb.public\"\n ],\n \"type\": \"managed\",\n \"resource_name\": \"my-postgres\",\n \"rotate_password\": false,\n \"source_role\": \"pg_read_all_data\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"message": "failed retrieving resource: connection refused",
"resource_name": "my-postgres",
"role": "hoopdev_my_postgres_ro_ab3c1f7e",
"sid": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
"status": "success"
}
]
}{
"message": "the error description"
}Resources
Creates a batch of resource plans
Validates provisioning plans for a batch of resources by computing the diff between the desired and current role state for each resource. Each item is session-audited and receives its own plan ID (SID) that can be referenced when applying. All items are processed concurrently and the response is returned once all have completed. Per-item failures are embedded in the results with status “failed” rather than returned as HTTP errors.
POST
/
resources
/
plan
Creates a batch of resource plans
curl --request POST \
--url https://use.hoop.dev/api/resources/plan \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"privileges": [
"SELECT",
"INSERT"
],
"role": "ro",
"scopes": [
"mydb",
"otherdb.public"
],
"type": "managed",
"resource_name": "my-postgres",
"rotate_password": false,
"source_role": "pg_read_all_data"
}
]
}
'import requests
url = "https://use.hoop.dev/api/resources/plan"
payload = { "items": [
{
"privileges": ["SELECT", "INSERT"],
"role": "ro",
"scopes": ["mydb", "otherdb.public"],
"type": "managed",
"resource_name": "my-postgres",
"rotate_password": False,
"source_role": "pg_read_all_data"
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
privileges: ['SELECT', 'INSERT'],
role: 'ro',
scopes: ['mydb', 'otherdb.public'],
type: 'managed',
resource_name: 'my-postgres',
rotate_password: false,
source_role: 'pg_read_all_data'
}
]
})
};
fetch('https://use.hoop.dev/api/resources/plan', 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://use.hoop.dev/api/resources/plan",
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([
'items' => [
[
'privileges' => [
'SELECT',
'INSERT'
],
'role' => 'ro',
'scopes' => [
'mydb',
'otherdb.public'
],
'type' => 'managed',
'resource_name' => 'my-postgres',
'rotate_password' => false,
'source_role' => 'pg_read_all_data'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://use.hoop.dev/api/resources/plan"
payload := strings.NewReader("{\n \"items\": [\n {\n \"privileges\": [\n \"SELECT\",\n \"INSERT\"\n ],\n \"role\": \"ro\",\n \"scopes\": [\n \"mydb\",\n \"otherdb.public\"\n ],\n \"type\": \"managed\",\n \"resource_name\": \"my-postgres\",\n \"rotate_password\": false,\n \"source_role\": \"pg_read_all_data\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://use.hoop.dev/api/resources/plan")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"privileges\": [\n \"SELECT\",\n \"INSERT\"\n ],\n \"role\": \"ro\",\n \"scopes\": [\n \"mydb\",\n \"otherdb.public\"\n ],\n \"type\": \"managed\",\n \"resource_name\": \"my-postgres\",\n \"rotate_password\": false,\n \"source_role\": \"pg_read_all_data\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/resources/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"privileges\": [\n \"SELECT\",\n \"INSERT\"\n ],\n \"role\": \"ro\",\n \"scopes\": [\n \"mydb\",\n \"otherdb.public\"\n ],\n \"type\": \"managed\",\n \"resource_name\": \"my-postgres\",\n \"rotate_password\": false,\n \"source_role\": \"pg_read_all_data\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"message": "failed retrieving resource: connection refused",
"resource_name": "my-postgres",
"role": "hoopdev_my_postgres_ro_ab3c1f7e",
"sid": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
"status": "success"
}
]
}{
"message": "the error description"
}Was this page helpful?
⌘I