Skip to main content
PUT
/
attributes
/
{name}
Update Attribute
curl --request PUT \
  --url https://use.hoop.dev/api/attributes/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "default-session-attribute",
  "access_control_group_names": [
    "engineering",
    "sre"
  ],
  "access_request_rule_names": [
    "rule1",
    "rule2"
  ],
  "connection_names": [
    "pgdemo",
    "mysql-prod"
  ],
  "datamasking_rule_names": [
    "rule1",
    "rule2"
  ],
  "description": "Blocks high-risk SQL commands",
  "guardrail_rule_names": [
    "rule1",
    "rule2"
  ]
}
'
import requests

url = "https://use.hoop.dev/api/attributes/{name}"

payload = {
"name": "default-session-attribute",
"access_control_group_names": ["engineering", "sre"],
"access_request_rule_names": ["rule1", "rule2"],
"connection_names": ["pgdemo", "mysql-prod"],
"datamasking_rule_names": ["rule1", "rule2"],
"description": "Blocks high-risk SQL commands",
"guardrail_rule_names": ["rule1", "rule2"]
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'default-session-attribute',
access_control_group_names: ['engineering', 'sre'],
access_request_rule_names: ['rule1', 'rule2'],
connection_names: ['pgdemo', 'mysql-prod'],
datamasking_rule_names: ['rule1', 'rule2'],
description: 'Blocks high-risk SQL commands',
guardrail_rule_names: ['rule1', 'rule2']
})
};

fetch('https://use.hoop.dev/api/attributes/{name}', 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/attributes/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'default-session-attribute',
'access_control_group_names' => [
'engineering',
'sre'
],
'access_request_rule_names' => [
'rule1',
'rule2'
],
'connection_names' => [
'pgdemo',
'mysql-prod'
],
'datamasking_rule_names' => [
'rule1',
'rule2'
],
'description' => 'Blocks high-risk SQL commands',
'guardrail_rule_names' => [
'rule1',
'rule2'
]
]),
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/attributes/{name}"

payload := strings.NewReader("{\n \"name\": \"default-session-attribute\",\n \"access_control_group_names\": [\n \"engineering\",\n \"sre\"\n ],\n \"access_request_rule_names\": [\n \"rule1\",\n \"rule2\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"datamasking_rule_names\": [\n \"rule1\",\n \"rule2\"\n ],\n \"description\": \"Blocks high-risk SQL commands\",\n \"guardrail_rule_names\": [\n \"rule1\",\n \"rule2\"\n ]\n}")

req, _ := http.NewRequest("PUT", 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.put("https://use.hoop.dev/api/attributes/{name}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"default-session-attribute\",\n \"access_control_group_names\": [\n \"engineering\",\n \"sre\"\n ],\n \"access_request_rule_names\": [\n \"rule1\",\n \"rule2\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"datamasking_rule_names\": [\n \"rule1\",\n \"rule2\"\n ],\n \"description\": \"Blocks high-risk SQL commands\",\n \"guardrail_rule_names\": [\n \"rule1\",\n \"rule2\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://use.hoop.dev/api/attributes/{name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"default-session-attribute\",\n \"access_control_group_names\": [\n \"engineering\",\n \"sre\"\n ],\n \"access_request_rule_names\": [\n \"rule1\",\n \"rule2\"\n ],\n \"connection_names\": [\n \"pgdemo\",\n \"mysql-prod\"\n ],\n \"datamasking_rule_names\": [\n \"rule1\",\n \"rule2\"\n ],\n \"description\": \"Blocks high-risk SQL commands\",\n \"guardrail_rule_names\": [\n \"rule1\",\n \"rule2\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "access_control_group_names": [
    "engineering",
    "sre"
  ],
  "access_request_rule_names": [
    "rule1",
    "rule2"
  ],
  "connection_names": [
    "pgdemo",
    "mysql-prod"
  ],
  "created_at": "2024-07-25T15:56:35.317601Z",
  "datamasking_rule_names": [
    "rule1",
    "rule2"
  ],
  "description": "Blocks high-risk SQL commands",
  "guardrail_rule_names": [
    "rule1",
    "rule2"
  ],
  "id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "name": "default-session-attribute",
  "org_id": "37EEBC20-D8DF-416B-8AC2-01B6EB456318"
}
{
"message": "the error description"
}
{
"message": "the error description"
}
{
"message": "the error description"
}

Path Parameters

name
string
required

Name of the attribute

Body

application/json

The request body resource

name
string
required
Example:

"default-session-attribute"

access_control_group_names
string[]
Example:
["engineering", "sre"]
access_request_rule_names
string[]
Example:
["rule1", "rule2"]
connection_names
string[]
Example:
["pgdemo", "mysql-prod"]
datamasking_rule_names
string[]
Example:
["rule1", "rule2"]
description
string

The description of the attribute

Example:

"Blocks high-risk SQL commands"

guardrail_rule_names
string[]
Example:
["rule1", "rule2"]

Response

OK

access_control_group_names
string[]

Access control group names associated with this attribute

Example:
["engineering", "sre"]
access_request_rule_names
string[]

Access request rule names associated with this attribute

Example:
["rule1", "rule2"]
connection_names
string[]

Connection names associated with this attribute

Example:
["pgdemo", "mysql-prod"]
created_at
string
read-only

The time the resource was created

Example:

"2024-07-25T15:56:35.317601Z"

datamasking_rule_names
string[]

Datamasking rule names associated with this attribute

Example:
["rule1", "rule2"]
description
string

The description of the attribute

Example:

"Blocks high-risk SQL commands"

guardrail_rule_names
string[]

Guardrail rule names associated with this attribute

Example:
["rule1", "rule2"]
id
string<uuid>
read-only

The resource identifier

Example:

"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7"

name
string

The name of the attribute

Example:

"default-session-attribute"

org_id
string<uuid>
read-only

Organization ID that owns this attribute

Example:

"37EEBC20-D8DF-416B-8AC2-01B6EB456318"