Skip to main content
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"
  ]
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "deleted": 1
  }
}

Authorizations

api_key
string
header
required

Body

application/json
oId
string

Resource OId to delete (use either oId or oIds)

Example:

"res_abc123"

oIds
string[]

Array of resource OIds to delete (use either oId or oIds)

Example:
["res_abc123", "res_def456"]

Response

Resources deleted successfully

_metadata
object
required
data
object
required