Create a provisioned session using API Key
curl --request POST \
--url https://use.hoop.dev/api/sessions/approved \
--header 'Content-Type: application/json' \
--data '
{
"connection": "pgdemo",
"user_email": "johnwick@bad.org",
"access_duration_sec": 123,
"approved_reviewers": [
"<string>"
],
"client_args": [
"<string>"
],
"env_vars": {},
"jira_fields": {},
"metadata": {},
"script": "<string>"
}
'import requests
url = "https://use.hoop.dev/api/sessions/approved"
payload = {
"connection": "pgdemo",
"user_email": "johnwick@bad.org",
"access_duration_sec": 123,
"approved_reviewers": ["<string>"],
"client_args": ["<string>"],
"env_vars": {},
"jira_fields": {},
"metadata": {},
"script": "<string>"
}
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({
connection: 'pgdemo',
user_email: 'johnwick@bad.org',
access_duration_sec: 123,
approved_reviewers: ['<string>'],
client_args: ['<string>'],
env_vars: {},
jira_fields: {},
metadata: {},
script: '<string>'
})
};
fetch('https://use.hoop.dev/api/sessions/approved', 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/sessions/approved",
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([
'connection' => 'pgdemo',
'user_email' => 'johnwick@bad.org',
'access_duration_sec' => 123,
'approved_reviewers' => [
'<string>'
],
'client_args' => [
'<string>'
],
'env_vars' => [
],
'jira_fields' => [
],
'metadata' => [
],
'script' => '<string>'
]),
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/sessions/approved"
payload := strings.NewReader("{\n \"connection\": \"pgdemo\",\n \"user_email\": \"johnwick@bad.org\",\n \"access_duration_sec\": 123,\n \"approved_reviewers\": [\n \"<string>\"\n ],\n \"client_args\": [\n \"<string>\"\n ],\n \"env_vars\": {},\n \"jira_fields\": {},\n \"metadata\": {},\n \"script\": \"<string>\"\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/sessions/approved")
.header("Content-Type", "application/json")
.body("{\n \"connection\": \"pgdemo\",\n \"user_email\": \"johnwick@bad.org\",\n \"access_duration_sec\": 123,\n \"approved_reviewers\": [\n \"<string>\"\n ],\n \"client_args\": [\n \"<string>\"\n ],\n \"env_vars\": {},\n \"jira_fields\": {},\n \"metadata\": {},\n \"script\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/sessions/approved")
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 \"connection\": \"pgdemo\",\n \"user_email\": \"johnwick@bad.org\",\n \"access_duration_sec\": 123,\n \"approved_reviewers\": [\n \"<string>\"\n ],\n \"client_args\": [\n \"<string>\"\n ],\n \"env_vars\": {},\n \"jira_fields\": {},\n \"metadata\": {},\n \"script\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"has_review": false,
"session_id": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
"user_email": "johnwick@bad.org"
}{
"message": "the error description"
}{
"message": "the error description"
}{
"message": "the error description"
}Sessions
Create a provisioned session using API Key
POST
/
sessions
/
approved
Create a provisioned session using API Key
curl --request POST \
--url https://use.hoop.dev/api/sessions/approved \
--header 'Content-Type: application/json' \
--data '
{
"connection": "pgdemo",
"user_email": "johnwick@bad.org",
"access_duration_sec": 123,
"approved_reviewers": [
"<string>"
],
"client_args": [
"<string>"
],
"env_vars": {},
"jira_fields": {},
"metadata": {},
"script": "<string>"
}
'import requests
url = "https://use.hoop.dev/api/sessions/approved"
payload = {
"connection": "pgdemo",
"user_email": "johnwick@bad.org",
"access_duration_sec": 123,
"approved_reviewers": ["<string>"],
"client_args": ["<string>"],
"env_vars": {},
"jira_fields": {},
"metadata": {},
"script": "<string>"
}
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({
connection: 'pgdemo',
user_email: 'johnwick@bad.org',
access_duration_sec: 123,
approved_reviewers: ['<string>'],
client_args: ['<string>'],
env_vars: {},
jira_fields: {},
metadata: {},
script: '<string>'
})
};
fetch('https://use.hoop.dev/api/sessions/approved', 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/sessions/approved",
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([
'connection' => 'pgdemo',
'user_email' => 'johnwick@bad.org',
'access_duration_sec' => 123,
'approved_reviewers' => [
'<string>'
],
'client_args' => [
'<string>'
],
'env_vars' => [
],
'jira_fields' => [
],
'metadata' => [
],
'script' => '<string>'
]),
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/sessions/approved"
payload := strings.NewReader("{\n \"connection\": \"pgdemo\",\n \"user_email\": \"johnwick@bad.org\",\n \"access_duration_sec\": 123,\n \"approved_reviewers\": [\n \"<string>\"\n ],\n \"client_args\": [\n \"<string>\"\n ],\n \"env_vars\": {},\n \"jira_fields\": {},\n \"metadata\": {},\n \"script\": \"<string>\"\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/sessions/approved")
.header("Content-Type", "application/json")
.body("{\n \"connection\": \"pgdemo\",\n \"user_email\": \"johnwick@bad.org\",\n \"access_duration_sec\": 123,\n \"approved_reviewers\": [\n \"<string>\"\n ],\n \"client_args\": [\n \"<string>\"\n ],\n \"env_vars\": {},\n \"jira_fields\": {},\n \"metadata\": {},\n \"script\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/sessions/approved")
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 \"connection\": \"pgdemo\",\n \"user_email\": \"johnwick@bad.org\",\n \"access_duration_sec\": 123,\n \"approved_reviewers\": [\n \"<string>\"\n ],\n \"client_args\": [\n \"<string>\"\n ],\n \"env_vars\": {},\n \"jira_fields\": {},\n \"metadata\": {},\n \"script\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"has_review": false,
"session_id": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
"user_email": "johnwick@bad.org"
}{
"message": "the error description"
}{
"message": "the error description"
}{
"message": "the error description"
}Body
application/json
The request body resource
Example:
"pgdemo"
Example:
"johnwick@bad.org"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I