Skip to main content
POST
/
sessions
/
provision
Create a provisioned session using API Key
curl --request POST \
  --url https://use.hoop.dev/api/sessions/provision \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection": "pgdemo",
  "user_email": "johnwick@bad.org",
  "access_duration_sec": 123,
  "approved_reviewers": [
    "<string>"
  ],
  "client_args": [
    "<string>"
  ],
  "correlation_id": "task-12345",
  "env_vars": {},
  "jira_fields": {},
  "metadata": {},
  "script": "<string>"
}
'
{
  "has_review": false,
  "session_id": "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
  "user_email": "johnwick@bad.org"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.hoop.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

The request body resource

​
connection
string
required
Example:

"pgdemo"

​
user_email
string
required
Example:

"johnwick@bad.org"

​
access_duration_sec
integer
​
approved_reviewers
string[]
​
client_args
string[]
​
correlation_id
string

External workflow/task identifier that groups sessions belonging to the same logical run

Example:

"task-12345"

​
env_vars
object
​
jira_fields
object
​
metadata
object
​
script
string
​
time_window
object

Response

The session has been created

​
has_review
boolean
Example:

false

​
session_id
string<uuid>
Example:

"5701046A-7B7A-4A78-ABB0-A24C95E6FE54"

​
user_email
string
Example:

"johnwick@bad.org"