Regenerate an API key
curl --request POST \
--url https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate \
--header 'Accept: <accept>' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ApiKeyId": "<string>"
}
'import requests
url = "https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate"
payload = { "ApiKeyId": "<string>" }
headers = {
"Accept": "<accept>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Accept: '<accept>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ApiKeyId: '<string>'})
};
fetch('https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate', 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://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate",
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([
'ApiKeyId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <api-key>",
"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://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate"
payload := strings.NewReader("{\n \"ApiKeyId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Accept", "<accept>")
req.Header.Add("Authorization", "<api-key>")
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://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate")
.header("Accept", "<accept>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ApiKeyId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ApiKeyId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ApiKey": "<string>",
"ClientRef": "<string>",
"Expired": true,
"IsActive": true,
"Expires": "2023-11-07T05:31:56Z",
"CancelledDate": "2023-11-07T05:31:56Z",
"Parallelism": 123,
"IsTrial": true,
"KeyType": "Usage"
}{
"ApiKey": "<string>",
"ClientRef": "<string>",
"Expired": true,
"IsActive": true,
"Expires": "2023-11-07T05:31:56Z",
"CancelledDate": "2023-11-07T05:31:56Z",
"Parallelism": 123,
"IsTrial": true,
"KeyType": "Usage"
}{
"ApiKey": "<string>",
"ClientRef": "<string>",
"Expired": true,
"IsActive": true,
"Expires": "2023-11-07T05:31:56Z",
"CancelledDate": "2023-11-07T05:31:56Z",
"Parallelism": 123,
"IsTrial": true,
"KeyType": "Usage"
}Account & keys
Regenerate an API key
Admin only. Rotates one of the account’s keys: cancels the old secret and issues a new one, carrying the key’s reference, expiry, type, parallelism, fairness weight and allowed origins forward. The old key stops working immediately, so update integrations with the returned key.
Path
ApiKeyId— the id of the key to rotate.
POST
/
admin
/
keys
/
{ApiKeyId}
/
regenerate
Regenerate an API key
curl --request POST \
--url https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate \
--header 'Accept: <accept>' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ApiKeyId": "<string>"
}
'import requests
url = "https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate"
payload = { "ApiKeyId": "<string>" }
headers = {
"Accept": "<accept>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Accept: '<accept>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ApiKeyId: '<string>'})
};
fetch('https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate', 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://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate",
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([
'ApiKeyId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <api-key>",
"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://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate"
payload := strings.NewReader("{\n \"ApiKeyId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Accept", "<accept>")
req.Header.Add("Authorization", "<api-key>")
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://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate")
.header("Accept", "<accept>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ApiKeyId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/regenerate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ApiKeyId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ApiKey": "<string>",
"ClientRef": "<string>",
"Expired": true,
"IsActive": true,
"Expires": "2023-11-07T05:31:56Z",
"CancelledDate": "2023-11-07T05:31:56Z",
"Parallelism": 123,
"IsTrial": true,
"KeyType": "Usage"
}{
"ApiKey": "<string>",
"ClientRef": "<string>",
"Expired": true,
"IsActive": true,
"Expires": "2023-11-07T05:31:56Z",
"CancelledDate": "2023-11-07T05:31:56Z",
"Parallelism": 123,
"IsTrial": true,
"KeyType": "Usage"
}{
"ApiKey": "<string>",
"ClientRef": "<string>",
"Expired": true,
"IsActive": true,
"Expires": "2023-11-07T05:31:56Z",
"CancelledDate": "2023-11-07T05:31:56Z",
"Parallelism": 123,
"IsTrial": true,
"KeyType": "Usage"
}Authorizations
Headers
Accept Header
Available options:
application/json Path Parameters
Body
application/json
RegenerateApiKey