Global resources (v1)

Remove an element from a resource

Remove a top-level element from an array or a key from an object in a resource. Returns the removed item. If the resource has a test value it can be modified using the is_test parameter.

post/api/v1/global_resources/{id}/remove

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/global_resources/{id}/remove
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

idinteger required

The ID of the live resource

Request body

keystring

The object key to remove if removing from an object

indexinteger

The array index to remove (starting at 0). If omitted, the last element is removed

if_valuestring

When provided, only proceeds if the current value at the key or index matches; otherwise a 422 with the current value is returned. A null value is treated as omitting the parameter

is_testboolean

Whether the test resource should be used

Response

The removed item from the resource

Changes

No recorded changes to this operation across all 1 revision of this API.