Revoke a sandbox agent credential
curl --request POST \
--url https://api.example.com/v1/agent-credentials/{credentialId}/revoke \
--header 'Content-Type: application/json' \
--header 'x-ws-api-key: <api-key>' \
--data '
{
"reason": "Prototype finished; credential no longer needed."
}
'import requests
url = "https://api.example.com/v1/agent-credentials/{credentialId}/revoke"
payload = { "reason": "Prototype finished; credential no longer needed." }
headers = {
"x-ws-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-ws-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Prototype finished; credential no longer needed.'})
};
fetch('https://api.example.com/v1/agent-credentials/{credentialId}/revoke', 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/v1/agent-credentials/{credentialId}/revoke",
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([
'reason' => 'Prototype finished; credential no longer needed.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ws-api-key: <api-key>"
],
]);
$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/v1/agent-credentials/{credentialId}/revoke"
payload := strings.NewReader("{\n \"reason\": \"Prototype finished; credential no longer needed.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-ws-api-key", "<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://api.example.com/v1/agent-credentials/{credentialId}/revoke")
.header("x-ws-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Prototype finished; credential no longer needed.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/agent-credentials/{credentialId}/revoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ws-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Prototype finished; credential no longer needed.\"\n}"
response = http.request(request)
puts response.read_body{
"outcome": "revoked",
"credential_id": "ws_agent_cred_123456789",
"request_id": "ws_request_123456789",
"production_access": false,
"next_steps": "Request a new sandbox credential when you need API access again."
}{
"request_id": "req_123",
"error_code": "VALIDATION_FAILED",
"message": "Request validation failed.",
"field_errors": [
{
"field": "zipcode",
"message": "zipcode is invalid"
}
]
}{
"request_id": "req_123",
"error_code": "AUTH_MISSING_API_KEY",
"message": "Missing x-ws-api-key header.",
"recovery_action": "Provide the x-ws-api-key header. If this contradicts the public docs or OpenAPI contract, submit structured feedback through /v1/feedback."
}agent-credentials
Revoke a sandbox agent credential
POST
/
v1
/
agent-credentials
/
{credentialId}
/
revoke
Revoke a sandbox agent credential
curl --request POST \
--url https://api.example.com/v1/agent-credentials/{credentialId}/revoke \
--header 'Content-Type: application/json' \
--header 'x-ws-api-key: <api-key>' \
--data '
{
"reason": "Prototype finished; credential no longer needed."
}
'import requests
url = "https://api.example.com/v1/agent-credentials/{credentialId}/revoke"
payload = { "reason": "Prototype finished; credential no longer needed." }
headers = {
"x-ws-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-ws-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Prototype finished; credential no longer needed.'})
};
fetch('https://api.example.com/v1/agent-credentials/{credentialId}/revoke', 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/v1/agent-credentials/{credentialId}/revoke",
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([
'reason' => 'Prototype finished; credential no longer needed.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ws-api-key: <api-key>"
],
]);
$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/v1/agent-credentials/{credentialId}/revoke"
payload := strings.NewReader("{\n \"reason\": \"Prototype finished; credential no longer needed.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-ws-api-key", "<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://api.example.com/v1/agent-credentials/{credentialId}/revoke")
.header("x-ws-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Prototype finished; credential no longer needed.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/agent-credentials/{credentialId}/revoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ws-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Prototype finished; credential no longer needed.\"\n}"
response = http.request(request)
puts response.read_body{
"outcome": "revoked",
"credential_id": "ws_agent_cred_123456789",
"request_id": "ws_request_123456789",
"production_access": false,
"next_steps": "Request a new sandbox credential when you need API access again."
}{
"request_id": "req_123",
"error_code": "VALIDATION_FAILED",
"message": "Request validation failed.",
"field_errors": [
{
"field": "zipcode",
"message": "zipcode is invalid"
}
]
}{
"request_id": "req_123",
"error_code": "AUTH_MISSING_API_KEY",
"message": "Missing x-ws-api-key header.",
"recovery_action": "Provide the x-ws-api-key header. If this contradicts the public docs or OpenAPI contract, submit structured feedback through /v1/feedback."
}Authorizations
WattShift API key
Headers
WattShift API Key
Path Parameters
Body
application/json
Maximum string length:
255⌘I
