cURL
curl --request PUT \
--url https://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"rate_limits": [
{
"value": 1
}
],
"usage_limits": {
"credit_limit": 2,
"alert_threshold": 2,
"periodic_reset_days": 183,
"next_usage_reset_at": "2023-11-07T05:31:56Z"
},
"reset_usage": true,
"scopes": [
"<string>"
],
"defaults": {
"metadata": {},
"config_id": "<string>",
"allow_config_override": true
},
"alert_emails": [
"jsmith@example.com"
],
"expires_at": "2023-11-07T05:31:56Z",
"rotation_policy": {
"next_rotation_at": "2023-11-07T05:31:56Z",
"key_transition_period_ms": 1800001
}
}
'import requests
url = "https://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"rate_limits": [{ "value": 1 }],
"usage_limits": {
"credit_limit": 2,
"alert_threshold": 2,
"periodic_reset_days": 183,
"next_usage_reset_at": "2023-11-07T05:31:56Z"
},
"reset_usage": True,
"scopes": ["<string>"],
"defaults": {
"metadata": {},
"config_id": "<string>",
"allow_config_override": True
},
"alert_emails": ["jsmith@example.com"],
"expires_at": "2023-11-07T05:31:56Z",
"rotation_policy": {
"next_rotation_at": "2023-11-07T05:31:56Z",
"key_transition_period_ms": 1800001
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
rate_limits: [{value: 1}],
usage_limits: {
credit_limit: 2,
alert_threshold: 2,
periodic_reset_days: 183,
next_usage_reset_at: '2023-11-07T05:31:56Z'
},
reset_usage: true,
scopes: ['<string>'],
defaults: {metadata: {}, config_id: '<string>', allow_config_override: true},
alert_emails: ['jsmith@example.com'],
expires_at: '2023-11-07T05:31:56Z',
rotation_policy: {next_rotation_at: '2023-11-07T05:31:56Z', key_transition_period_ms: 1800001}
})
};
fetch('https://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}', 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://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}",
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' => '<string>',
'description' => '<string>',
'rate_limits' => [
[
'value' => 1
]
],
'usage_limits' => [
'credit_limit' => 2,
'alert_threshold' => 2,
'periodic_reset_days' => 183,
'next_usage_reset_at' => '2023-11-07T05:31:56Z'
],
'reset_usage' => true,
'scopes' => [
'<string>'
],
'defaults' => [
'metadata' => [
],
'config_id' => '<string>',
'allow_config_override' => true
],
'alert_emails' => [
'jsmith@example.com'
],
'expires_at' => '2023-11-07T05:31:56Z',
'rotation_policy' => [
'next_rotation_at' => '2023-11-07T05:31:56Z',
'key_transition_period_ms' => 1800001
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rate_limits\": [\n {\n \"value\": 1\n }\n ],\n \"usage_limits\": {\n \"credit_limit\": 2,\n \"alert_threshold\": 2,\n \"periodic_reset_days\": 183,\n \"next_usage_reset_at\": \"2023-11-07T05:31:56Z\"\n },\n \"reset_usage\": true,\n \"scopes\": [\n \"<string>\"\n ],\n \"defaults\": {\n \"metadata\": {},\n \"config_id\": \"<string>\",\n \"allow_config_override\": true\n },\n \"alert_emails\": [\n \"jsmith@example.com\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"rotation_policy\": {\n \"next_rotation_at\": \"2023-11-07T05:31:56Z\",\n \"key_transition_period_ms\": 1800001\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rate_limits\": [\n {\n \"value\": 1\n }\n ],\n \"usage_limits\": {\n \"credit_limit\": 2,\n \"alert_threshold\": 2,\n \"periodic_reset_days\": 183,\n \"next_usage_reset_at\": \"2023-11-07T05:31:56Z\"\n },\n \"reset_usage\": true,\n \"scopes\": [\n \"<string>\"\n ],\n \"defaults\": {\n \"metadata\": {},\n \"config_id\": \"<string>\",\n \"allow_config_override\": true\n },\n \"alert_emails\": [\n \"jsmith@example.com\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"rotation_policy\": {\n \"next_rotation_at\": \"2023-11-07T05:31:56Z\",\n \"key_transition_period_ms\": 1800001\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rate_limits\": [\n {\n \"value\": 1\n }\n ],\n \"usage_limits\": {\n \"credit_limit\": 2,\n \"alert_threshold\": 2,\n \"periodic_reset_days\": 183,\n \"next_usage_reset_at\": \"2023-11-07T05:31:56Z\"\n },\n \"reset_usage\": true,\n \"scopes\": [\n \"<string>\"\n ],\n \"defaults\": {\n \"metadata\": {},\n \"config_id\": \"<string>\",\n \"allow_config_override\": true\n },\n \"alert_emails\": [\n \"jsmith@example.com\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"rotation_policy\": {\n \"next_rotation_at\": \"2023-11-07T05:31:56Z\",\n \"key_transition_period_ms\": 1800001\n }\n}"
response = http.request(request)
puts response.read_body{}Put api keys by id
PUT
/
api-keys
/
{id}
cURL
curl --request PUT \
--url https://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"rate_limits": [
{
"value": 1
}
],
"usage_limits": {
"credit_limit": 2,
"alert_threshold": 2,
"periodic_reset_days": 183,
"next_usage_reset_at": "2023-11-07T05:31:56Z"
},
"reset_usage": true,
"scopes": [
"<string>"
],
"defaults": {
"metadata": {},
"config_id": "<string>",
"allow_config_override": true
},
"alert_emails": [
"jsmith@example.com"
],
"expires_at": "2023-11-07T05:31:56Z",
"rotation_policy": {
"next_rotation_at": "2023-11-07T05:31:56Z",
"key_transition_period_ms": 1800001
}
}
'import requests
url = "https://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"rate_limits": [{ "value": 1 }],
"usage_limits": {
"credit_limit": 2,
"alert_threshold": 2,
"periodic_reset_days": 183,
"next_usage_reset_at": "2023-11-07T05:31:56Z"
},
"reset_usage": True,
"scopes": ["<string>"],
"defaults": {
"metadata": {},
"config_id": "<string>",
"allow_config_override": True
},
"alert_emails": ["jsmith@example.com"],
"expires_at": "2023-11-07T05:31:56Z",
"rotation_policy": {
"next_rotation_at": "2023-11-07T05:31:56Z",
"key_transition_period_ms": 1800001
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
rate_limits: [{value: 1}],
usage_limits: {
credit_limit: 2,
alert_threshold: 2,
periodic_reset_days: 183,
next_usage_reset_at: '2023-11-07T05:31:56Z'
},
reset_usage: true,
scopes: ['<string>'],
defaults: {metadata: {}, config_id: '<string>', allow_config_override: true},
alert_emails: ['jsmith@example.com'],
expires_at: '2023-11-07T05:31:56Z',
rotation_policy: {next_rotation_at: '2023-11-07T05:31:56Z', key_transition_period_ms: 1800001}
})
};
fetch('https://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}', 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://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}",
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' => '<string>',
'description' => '<string>',
'rate_limits' => [
[
'value' => 1
]
],
'usage_limits' => [
'credit_limit' => 2,
'alert_threshold' => 2,
'periodic_reset_days' => 183,
'next_usage_reset_at' => '2023-11-07T05:31:56Z'
],
'reset_usage' => true,
'scopes' => [
'<string>'
],
'defaults' => [
'metadata' => [
],
'config_id' => '<string>',
'allow_config_override' => true
],
'alert_emails' => [
'jsmith@example.com'
],
'expires_at' => '2023-11-07T05:31:56Z',
'rotation_policy' => [
'next_rotation_at' => '2023-11-07T05:31:56Z',
'key_transition_period_ms' => 1800001
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rate_limits\": [\n {\n \"value\": 1\n }\n ],\n \"usage_limits\": {\n \"credit_limit\": 2,\n \"alert_threshold\": 2,\n \"periodic_reset_days\": 183,\n \"next_usage_reset_at\": \"2023-11-07T05:31:56Z\"\n },\n \"reset_usage\": true,\n \"scopes\": [\n \"<string>\"\n ],\n \"defaults\": {\n \"metadata\": {},\n \"config_id\": \"<string>\",\n \"allow_config_override\": true\n },\n \"alert_emails\": [\n \"jsmith@example.com\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"rotation_policy\": {\n \"next_rotation_at\": \"2023-11-07T05:31:56Z\",\n \"key_transition_period_ms\": 1800001\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rate_limits\": [\n {\n \"value\": 1\n }\n ],\n \"usage_limits\": {\n \"credit_limit\": 2,\n \"alert_threshold\": 2,\n \"periodic_reset_days\": 183,\n \"next_usage_reset_at\": \"2023-11-07T05:31:56Z\"\n },\n \"reset_usage\": true,\n \"scopes\": [\n \"<string>\"\n ],\n \"defaults\": {\n \"metadata\": {},\n \"config_id\": \"<string>\",\n \"allow_config_override\": true\n },\n \"alert_emails\": [\n \"jsmith@example.com\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"rotation_policy\": {\n \"next_rotation_at\": \"2023-11-07T05:31:56Z\",\n \"key_transition_period_ms\": 1800001\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.apps.paloaltonetworks.com/ai_gw/v2/api-keys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rate_limits\": [\n {\n \"value\": 1\n }\n ],\n \"usage_limits\": {\n \"credit_limit\": 2,\n \"alert_threshold\": 2,\n \"periodic_reset_days\": 183,\n \"next_usage_reset_at\": \"2023-11-07T05:31:56Z\"\n },\n \"reset_usage\": true,\n \"scopes\": [\n \"<string>\"\n ],\n \"defaults\": {\n \"metadata\": {},\n \"config_id\": \"<string>\",\n \"allow_config_override\": true\n },\n \"alert_emails\": [\n \"jsmith@example.com\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"rotation_policy\": {\n \"next_rotation_at\": \"2023-11-07T05:31:56Z\",\n \"key_transition_period_ms\": 1800001\n }\n}"
response = http.request(request)
puts response.read_body{}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
200 - application/json
The response is of type object.
Last modified on September 18, 2026
Was this page helpful?