Skip to content

Create data access request

POST
/v1/requests
curl --request POST \
--url https://localhost:8080/v1/requests \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "business_justification": "example", "datasource_names": [ "example" ], "description": "example", "external_ticket_id": "example", "external_ticket_url": "example", "parameters": { "additionalProperty": "example" }, "proxy_config": { "column_policies": [ { "action": "example", "partial_chars": 1, "partial_position": "example", "pattern": "example", "strategy": "example" } ], "datasource_id": "example", "disabled_datasets": [ "example" ], "session_rules": { "concurrent_sessions": { "enabled": true, "value": 1 }, "idle_timeout_seconds": { "enabled": true, "value": 1 }, "ip_allowlist": { "cidrs": [ "example" ], "enabled": true }, "query_rate_limit_per_minute": { "enabled": true, "value": 1 }, "schedule": { "enabled": true, "windows": [ { "days": [ "example" ], "end_time": "example", "start_time": "example" } ] }, "session_timeout_minutes": { "enabled": true, "value": 1 }, "sessions_per_day": { "enabled": true, "value": 1 } }, "signals": { "activity": { "action": "example", "enabled": true, "events": [ "example" ], "grace_period_minutes": 1, "idle_no_connections_minutes": 1, "idle_no_queries_minutes": 1, "query_limit": 1 }, "incident": { "action": "example", "enabled": true, "events": [ "example" ], "grace_period_minutes": 1, "incident_url": "example", "provider": "example" }, "issue_tracker": { "action": "example", "enabled": true, "events": [ "example" ], "grace_period_minutes": 1, "provider": "example", "ticket_url": "example" }, "time_based": { "action": "example", "business_hours_timezone": "example", "enabled": true, "events": [ "example" ], "grace_period_minutes": 1 } } }, "request_template_id": "example", "risk_level": "low", "scope": [ { "datasets": [ { "columns": [ "example" ], "filters": { "conditions": [ { "column": "example", "op": "example", "raw": "example", "value": "example" } ], "logic": "example" }, "joins": [ { "on": "example", "source": { "kind": "example", "name": "example" }, "type": "example" } ], "source": { "kind": "example", "name": "example" } } ], "datasource": "example", "virtual_table": { "name": "example", "sql": "example" } } ], "source": "manual", "title": "example", "type": "enclave", "valid_until": "example" }'

Creates a new data access request for the current user

Request details

Media typeapplication/json
object
business_justification
required
string
datasource_names
Array<string>
description
required
string
external_ticket_id
string
external_ticket_url
string
parameters

Parameters supplies values for [name] tags a template left in the scope, e.g. {“identifier”: “1226559”, “ticket_time”: “2026-02-09T12:39”}.

object
key
additional properties
string
proxy_config
object
column_policies
Array<object>
object
action

“block” | “deidentify”

string
partial_chars
integer
partial_position
string
pattern
string
strategy
string
datasource_id
string
disabled_datasets
Array<string>
session_rules
object
concurrent_sessions
object
enabled
boolean
value
integer
idle_timeout_seconds
object
enabled
boolean
value
integer
ip_allowlist
object
cidrs
Array<string>
enabled
boolean
query_rate_limit_per_minute
object
enabled
boolean
value
integer
schedule
object
enabled
boolean
windows
Array<object>
object
days

“mon” | “tue” | … | “sun”

Array<string>
end_time

“HH:MM” 24h

string
start_time

“HH:MM” 24h

string
session_timeout_minutes
object
enabled
boolean
value
integer
sessions_per_day
object
enabled
boolean
value
integer
signals
object
activity
object
action
string
enabled
boolean
events
Array<string>
grace_period_minutes
integer
idle_no_connections_minutes
integer
idle_no_queries_minutes
integer
query_limit
integer
incident
object
action
string
enabled
boolean
events
Array<string>
grace_period_minutes
integer
incident_url
string
provider

Pagerduty | opsgenie

string
issue_tracker
object
action
string
enabled
boolean
events
Array<string>
grace_period_minutes
integer
provider

Jira | linear | github | gitlab

string
ticket_url
string
time_based
object
action
string
business_hours_timezone
string
enabled
boolean
events
Array<string>
grace_period_minutes
integer
request_template_id
string
risk_level
string
Allowed values: low medium high
scope
Array<object>
object
datasets
required
Array<object>
>= 1 items
object
columns
required
Array<string>
>= 1 items
filters
object
conditions
required
Array<object>
>= 1 items
object
column
string
op
string
raw
string
value
logic
string
joins
Array<object>
object
on
string
source
object
kind
string
name
string
type
string
source
object
kind
string
name
string
datasource
required
string
virtual_table
object
name
string
sql
string
source
string
Allowed values: manual ticket ai
title
required
string
<= 255 characters
type
string
Allowed values: enclave proxied
valid_until
string

Created

Media typeapplication/json
object
data
object
approval_notes
string
approved_at
string
approved_by
string
business_justification
string
connection_details
object
database
string
host
string
password
string
port
integer
username
string
created_at
string
datasource_names
Array<string>
denial_reason
string
description
string
environment_id
string
environment_status
string
external_ticket_id
string
external_ticket_url
string
id
string
kind
string
parameters
object
key
additional properties
string
proxy_config
object
column_policies
Array<object>
object
action

“block” | “deidentify”

string
partial_chars
integer
partial_position
string
pattern
string
strategy
string
datasource_id
string
disabled_datasets
Array<string>
session_rules
object
concurrent_sessions
object
enabled
boolean
value
integer
idle_timeout_seconds
object
enabled
boolean
value
integer
ip_allowlist
object
cidrs
Array<string>
enabled
boolean
query_rate_limit_per_minute
object
enabled
boolean
value
integer
schedule
object
enabled
boolean
windows
Array<object>
object
days

“mon” | “tue” | … | “sun”

Array<string>
end_time

“HH:MM” 24h

string
start_time

“HH:MM” 24h

string
session_timeout_minutes
object
enabled
boolean
value
integer
sessions_per_day
object
enabled
boolean
value
integer
signals
object
activity
object
action
string
enabled
boolean
events
Array<string>
grace_period_minutes
integer
idle_no_connections_minutes
integer
idle_no_queries_minutes
integer
query_limit
integer
incident
object
action
string
enabled
boolean
events
Array<string>
grace_period_minutes
integer
incident_url
string
provider

Pagerduty | opsgenie

string
issue_tracker
object
action
string
enabled
boolean
events
Array<string>
grace_period_minutes
integer
provider

Jira | linear | github | gitlab

string
ticket_url
string
time_based
object
action
string
business_hours_timezone
string
enabled
boolean
events
Array<string>
grace_period_minutes
integer
request_template
object
available

Available reports whether the template still exists and is readable, so clients know whether it is safe to link to.

boolean
description
string
id
string
name
string
requester
object
email
string
id
string
name
string
risk_level
string
scope
object
credentials
object
key
additional properties
object
mappings
object
key
additional properties
string
reference
string
refs
object
key
additional properties
string
type
string
datasources
Array<object>
object
credential_ref
string
datasets
Array<object>
object
columns
Array<string>
filters
object
conditions
Array<object>
object
logic
string
joins
Array<object>
object
namespace
string
on
string
source
object
kind
string
name
string
table
string
type
string
namespace
string
source
object
kind
string
name
string
table
string
uri
string
virtual_table
object
name
string
sql
string
version
string
source
string
status
string
target_mcp_name
string
target_skill_slug
string
title
string
tunnel
object
api_url
string
connection_template
string
created_at
string
credentials
Array<object>
object
id
string
is_active
boolean
last_used_at
string
secret_preview
string
type
string
use_count
integer
username
string
edge_url
string
explorer_url
string
id
string
kind
string
last_error
string
local_forward_command
string
provider
string
public_host
string
public_port
integer
public_url
string
sidecar_name
string
status
string
updated_at
string
usage_events
Array<object>
object
action_type
string
id
string
ip_address
string
metadata
timestamp
string
type
string
updated_at
string
valid_until
string
success
boolean

Example generated

{
"data": {
"approval_notes": "example",
"approved_at": "example",
"approved_by": "example",
"business_justification": "example",
"connection_details": {
"database": "example",
"host": "example",
"password": "example",
"port": 1,
"username": "example"
},
"created_at": "example",
"datasource_names": [
"example"
],
"denial_reason": "example",
"description": "example",
"environment_id": "example",
"environment_status": "example",
"external_ticket_id": "example",
"external_ticket_url": "example",
"id": "example",
"kind": "example",
"parameters": {
"additionalProperty": "example"
},
"proxy_config": {
"column_policies": [
{
"action": "example",
"partial_chars": 1,
"partial_position": "example",
"pattern": "example",
"strategy": "example"
}
],
"datasource_id": "example",
"disabled_datasets": [
"example"
],
"session_rules": {
"concurrent_sessions": {
"enabled": true,
"value": 1
},
"idle_timeout_seconds": {
"enabled": true,
"value": 1
},
"ip_allowlist": {
"cidrs": [
"example"
],
"enabled": true
},
"query_rate_limit_per_minute": {
"enabled": true,
"value": 1
},
"schedule": {
"enabled": true,
"windows": [
{
"days": [
"example"
],
"end_time": "example",
"start_time": "example"
}
]
},
"session_timeout_minutes": {
"enabled": true,
"value": 1
},
"sessions_per_day": {
"enabled": true,
"value": 1
}
},
"signals": {
"activity": {
"action": "example",
"enabled": true,
"events": [
"example"
],
"grace_period_minutes": 1,
"idle_no_connections_minutes": 1,
"idle_no_queries_minutes": 1,
"query_limit": 1
},
"incident": {
"action": "example",
"enabled": true,
"events": [
"example"
],
"grace_period_minutes": 1,
"incident_url": "example",
"provider": "example"
},
"issue_tracker": {
"action": "example",
"enabled": true,
"events": [
"example"
],
"grace_period_minutes": 1,
"provider": "example",
"ticket_url": "example"
},
"time_based": {
"action": "example",
"business_hours_timezone": "example",
"enabled": true,
"events": [
"example"
],
"grace_period_minutes": 1
}
}
},
"request_template": {
"available": true,
"description": "example",
"id": "example",
"name": "example"
},
"requester": {
"email": "example",
"id": "example",
"name": "example"
},
"risk_level": "example",
"scope": {
"credentials": {
"additionalProperty": {
"mappings": {
"additionalProperty": "example"
},
"reference": "example",
"refs": {
"additionalProperty": "example"
},
"type": "example"
}
},
"datasources": [
{
"credential_ref": "example",
"datasets": [
{
"columns": [
"example"
],
"filters": {
"conditions": [
{}
],
"logic": "example"
},
"joins": [
{
"namespace": "example",
"on": "example",
"source": {
"kind": "example",
"name": "example"
},
"table": "example",
"type": "example"
}
],
"namespace": "example",
"source": {
"kind": "example",
"name": "example"
},
"table": "example"
}
],
"uri": "example",
"virtual_table": {
"name": "example",
"sql": "example"
}
}
],
"version": "example"
},
"source": "example",
"status": "example",
"target_mcp_name": "example",
"target_skill_slug": "example",
"title": "example",
"tunnel": {
"api_url": "example",
"connection_template": "example",
"created_at": "example",
"credentials": [
{
"id": "example",
"is_active": true,
"last_used_at": "example",
"secret_preview": "example",
"type": "example",
"use_count": 1,
"username": "example"
}
],
"edge_url": "example",
"explorer_url": "example",
"id": "example",
"kind": "example",
"last_error": "example",
"local_forward_command": "example",
"provider": "example",
"public_host": "example",
"public_port": 1,
"public_url": "example",
"sidecar_name": "example",
"status": "example",
"updated_at": "example",
"usage_events": [
{
"action_type": "example",
"id": "example",
"ip_address": "example",
"metadata": "example",
"timestamp": "example"
}
]
},
"type": "example",
"updated_at": "example",
"valid_until": "example"
},
"success": true
}

Bad Request

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Unauthorized

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Internal Server Error

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}