Set a key's Admin/Usage type
curl --request PATCH \
--url https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type \
--header 'Accept: <accept>' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ApiKeyId": "<string>",
"KeyType": "<string>"
}
'import requests
url = "https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type"
payload = {
"ApiKeyId": "<string>",
"KeyType": "<string>"
}
headers = {
"Accept": "<accept>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Accept: '<accept>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ApiKeyId: '<string>', KeyType: '<string>'})
};
fetch('https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type', 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}/type",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'ApiKeyId' => '<string>',
'KeyType' => '<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}/type"
payload := strings.NewReader("{\n \"ApiKeyId\": \"<string>\",\n \"KeyType\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type")
.header("Accept", "<accept>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ApiKeyId\": \"<string>\",\n \"KeyType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ApiKeyId\": \"<string>\",\n \"KeyType\": \"<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": "<string>"
}account
Set a key's Admin/Usage type
Admin only. Change a key’s capability class — e.g. downgrade a key you handed to a customer from Admin to Usage.
PATCH
/
admin
/
keys
/
{ApiKeyId}
/
type
Set a key's Admin/Usage type
curl --request PATCH \
--url https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type \
--header 'Accept: <accept>' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ApiKeyId": "<string>",
"KeyType": "<string>"
}
'import requests
url = "https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type"
payload = {
"ApiKeyId": "<string>",
"KeyType": "<string>"
}
headers = {
"Accept": "<accept>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Accept: '<accept>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ApiKeyId: '<string>', KeyType: '<string>'})
};
fetch('https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type', 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}/type",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'ApiKeyId' => '<string>',
'KeyType' => '<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}/type"
payload := strings.NewReader("{\n \"ApiKeyId\": \"<string>\",\n \"KeyType\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type")
.header("Accept", "<accept>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ApiKeyId\": \"<string>\",\n \"KeyType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.api.nestapi.com/admin/keys/{ApiKeyId}/type")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ApiKeyId\": \"<string>\",\n \"KeyType\": \"<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": "<string>"
}Authorizations
Headers
Accept Header
Available options:
application/json Path Parameters
Query Parameters
Available options:
Usage, Admin ⌘I