Delete Resource(s)
curl --request POST \
--url https://app.octavehq.com/api/v2/resource/delete \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"oId": "res_abc123",
"oIds": [
"res_abc123",
"res_def456"
]
}
'import requests
url = "https://app.octavehq.com/api/v2/resource/delete"
payload = {
"oId": "res_abc123",
"oIds": ["res_abc123", "res_def456"]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({oId: 'res_abc123', oIds: ['res_abc123', 'res_def456']})
};
fetch('https://app.octavehq.com/api/v2/resource/delete', 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://app.octavehq.com/api/v2/resource/delete",
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([
'oId' => 'res_abc123',
'oIds' => [
'res_abc123',
'res_def456'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://app.octavehq.com/api/v2/resource/delete"
payload := strings.NewReader("{\n \"oId\": \"res_abc123\",\n \"oIds\": [\n \"res_abc123\",\n \"res_def456\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://app.octavehq.com/api/v2/resource/delete")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"res_abc123\",\n \"oIds\": [\n \"res_abc123\",\n \"res_def456\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/resource/delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"oId\": \"res_abc123\",\n \"oIds\": [\n \"res_abc123\",\n \"res_def456\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"deleted": 1
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Resource
Delete Resource(s)
Soft delete one or more resources. Provide either a single oId or an array of oIds.
POST
/
api
/
v2
/
resource
/
delete
Delete Resource(s)
curl --request POST \
--url https://app.octavehq.com/api/v2/resource/delete \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"oId": "res_abc123",
"oIds": [
"res_abc123",
"res_def456"
]
}
'import requests
url = "https://app.octavehq.com/api/v2/resource/delete"
payload = {
"oId": "res_abc123",
"oIds": ["res_abc123", "res_def456"]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({oId: 'res_abc123', oIds: ['res_abc123', 'res_def456']})
};
fetch('https://app.octavehq.com/api/v2/resource/delete', 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://app.octavehq.com/api/v2/resource/delete",
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([
'oId' => 'res_abc123',
'oIds' => [
'res_abc123',
'res_def456'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://app.octavehq.com/api/v2/resource/delete"
payload := strings.NewReader("{\n \"oId\": \"res_abc123\",\n \"oIds\": [\n \"res_abc123\",\n \"res_def456\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://app.octavehq.com/api/v2/resource/delete")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"res_abc123\",\n \"oIds\": [\n \"res_abc123\",\n \"res_def456\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/resource/delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"oId\": \"res_abc123\",\n \"oIds\": [\n \"res_abc123\",\n \"res_def456\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"deleted": 1
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
⌘I