Regenerate an app API key (invalidates the old one)
Or generate initial key if app doesn't have one yet
POST /api/apps/:app_id/regenerate-key
curl --request POST \
--url https://api.example.com/api/apps/{app_id}/regenerate-key \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"pay_limits": {
"allowed_target_apps": [
"<string>"
],
"expires_at": "2023-11-07T05:31:56Z",
"max_payment_per_tx": 1,
"spend_allowance": 1
},
"permissions": []
}
'import requests
url = "https://api.example.com/api/apps/{app_id}/regenerate-key"
payload = {
"name": "<string>",
"pay_limits": {
"allowed_target_apps": ["<string>"],
"expires_at": "2023-11-07T05:31:56Z",
"max_payment_per_tx": 1,
"spend_allowance": 1
},
"permissions": []
}
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({
name: '<string>',
pay_limits: {
allowed_target_apps: ['<string>'],
expires_at: '2023-11-07T05:31:56Z',
max_payment_per_tx: 1,
spend_allowance: 1
},
permissions: []
})
};
fetch('https://api.example.com/api/apps/{app_id}/regenerate-key', 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.example.com/api/apps/{app_id}/regenerate-key",
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([
'name' => '<string>',
'pay_limits' => [
'allowed_target_apps' => [
'<string>'
],
'expires_at' => '2023-11-07T05:31:56Z',
'max_payment_per_tx' => 1,
'spend_allowance' => 1
],
'permissions' => [
]
]),
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://api.example.com/api/apps/{app_id}/regenerate-key"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"pay_limits\": {\n \"allowed_target_apps\": [\n \"<string>\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"max_payment_per_tx\": 1,\n \"spend_allowance\": 1\n },\n \"permissions\": []\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://api.example.com/api/apps/{app_id}/regenerate-key")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"pay_limits\": {\n \"allowed_target_apps\": [\n \"<string>\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"max_payment_per_tx\": 1,\n \"spend_allowance\": 1\n },\n \"permissions\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/apps/{app_id}/regenerate-key")
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 \"name\": \"<string>\",\n \"pay_limits\": {\n \"allowed_target_apps\": [\n \"<string>\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"max_payment_per_tx\": 1,\n \"spend_allowance\": 1\n },\n \"permissions\": []\n}"
response = http.request(request)
puts response.read_bodyAPI Keys
Regenerate an app API key (invalidates the old one) Or generate initial key if app doesn't have one yet POST /api/apps/:app_id/regenerate-key
POST
/
api
/
apps
/
{app_id}
/
regenerate-key
Regenerate an app API key (invalidates the old one)
Or generate initial key if app doesn't have one yet
POST /api/apps/:app_id/regenerate-key
curl --request POST \
--url https://api.example.com/api/apps/{app_id}/regenerate-key \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"pay_limits": {
"allowed_target_apps": [
"<string>"
],
"expires_at": "2023-11-07T05:31:56Z",
"max_payment_per_tx": 1,
"spend_allowance": 1
},
"permissions": []
}
'import requests
url = "https://api.example.com/api/apps/{app_id}/regenerate-key"
payload = {
"name": "<string>",
"pay_limits": {
"allowed_target_apps": ["<string>"],
"expires_at": "2023-11-07T05:31:56Z",
"max_payment_per_tx": 1,
"spend_allowance": 1
},
"permissions": []
}
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({
name: '<string>',
pay_limits: {
allowed_target_apps: ['<string>'],
expires_at: '2023-11-07T05:31:56Z',
max_payment_per_tx: 1,
spend_allowance: 1
},
permissions: []
})
};
fetch('https://api.example.com/api/apps/{app_id}/regenerate-key', 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.example.com/api/apps/{app_id}/regenerate-key",
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([
'name' => '<string>',
'pay_limits' => [
'allowed_target_apps' => [
'<string>'
],
'expires_at' => '2023-11-07T05:31:56Z',
'max_payment_per_tx' => 1,
'spend_allowance' => 1
],
'permissions' => [
]
]),
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://api.example.com/api/apps/{app_id}/regenerate-key"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"pay_limits\": {\n \"allowed_target_apps\": [\n \"<string>\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"max_payment_per_tx\": 1,\n \"spend_allowance\": 1\n },\n \"permissions\": []\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://api.example.com/api/apps/{app_id}/regenerate-key")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"pay_limits\": {\n \"allowed_target_apps\": [\n \"<string>\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"max_payment_per_tx\": 1,\n \"spend_allowance\": 1\n },\n \"permissions\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/apps/{app_id}/regenerate-key")
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 \"name\": \"<string>\",\n \"pay_limits\": {\n \"allowed_target_apps\": [\n \"<string>\"\n ],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"max_payment_per_tx\": 1,\n \"spend_allowance\": 1\n },\n \"permissions\": []\n}"
response = http.request(request)
puts response.read_bodyPath Parameters
Application ID
Body
application/json
Request body for generating a new app API key.
To create an Agent Key (for autonomous wallet-to-wallet payments), set
permissions: ["Pay"] and optionally populate the pay_limits block.
Response
App API key regenerated successfully
⌘I