Remove Vault Item Field
curl --request DELETE \
--url https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}', 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://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"X-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"
"net/http"
"io"
)
func main() {
url := "https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"fields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"type": "username",
"valueUpdatedAt": "2023-11-07T05:31:56Z",
"hint": "<string>",
"legacyName": "<string>",
"readableValue": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemKey": "<string>",
"kind": "login",
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastRotatedAt": "2023-11-07T05:31:56Z",
"lastRotatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastUsedAt": "2023-11-07T05:31:56Z",
"sourceAgentProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": 400,
"message": "<string>"
}{
"code": 401,
"message": "<string>"
}{
"code": 403,
"message": "<string>"
}{
"code": 404,
"message": "<string>"
}{
"code": 409,
"message": "<string>"
}{
"code": 500,
"message": "<string>"
}Vault
Remove Vault Item Field
DELETE
/
vault
/
items
/
{itemId}
/
fields
/
{fieldKey}
Remove Vault Item Field
curl --request DELETE \
--url https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}', 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://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"X-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"
"net/http"
"io"
)
func main() {
url := "https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields/{fieldKey}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"fields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"type": "username",
"valueUpdatedAt": "2023-11-07T05:31:56Z",
"hint": "<string>",
"legacyName": "<string>",
"readableValue": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemKey": "<string>",
"kind": "login",
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastRotatedAt": "2023-11-07T05:31:56Z",
"lastRotatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastUsedAt": "2023-11-07T05:31:56Z",
"sourceAgentProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": 400,
"message": "<string>"
}{
"code": 401,
"message": "<string>"
}{
"code": 403,
"message": "<string>"
}{
"code": 404,
"message": "<string>"
}{
"code": 409,
"message": "<string>"
}{
"code": 500,
"message": "<string>"
}Authorizations
Path Parameters
UPPER_SNAKE field key, unique within a template or item.
Required string length:
1 - 64Pattern:
^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$Response
The request has succeeded.
A vault item. Secret values live in WorkOS and never appear here.
Show child attributes
Show child attributes
Derived from name: kebab-case. Unique per organisation. Changes when the item is renamed.
Required string length:
1 - 64Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Kind of vault item. Templates and items need at least one field. Completeness is per-field required.
Available options:
login, api_key, card, custom Required string length:
1 - 200Set when this item was mirrored from a legacy agent-profile credentials set. Provenance only; the item is editable in the vault UI.
Template snapshotted at create. Provenance only.

